Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AdrianDC/advanced_development_shell_tools
Advanced Development Shell Tools - http://adriandc.github.io/advanced_development_shell_tools
https://github.com/AdrianDC/advanced_development_shell_tools
Last synced: 16 days ago
JSON representation
Advanced Development Shell Tools - http://adriandc.github.io/advanced_development_shell_tools
- Host: GitHub
- URL: https://github.com/AdrianDC/advanced_development_shell_tools
- Owner: AdrianDC
- License: apache-2.0
- Created: 2015-06-23T13:55:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-03-08T21:30:32.000Z (over 3 years ago)
- Last Synced: 2024-08-01T05:24:07.469Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 19.4 MB
- Stars: 80
- Watchers: 12
- Forks: 37
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### __Disclaimer__ ###
* No wrong use or side effect of this project shall involve the responsibility of its developers.
The scripts are shared as they are. Improvements are regularly done based on personal use
and developers reports, but no instantaneous changes shall be requested by anyone.
---
### __About the project__ ###
* The project [**advanced_development_shell_tools**](https://github.com/AdrianDC/advanced_development_shell_tools) started in 2015
to **ease Android and Linux developments, ADB usage, Git commands and related projects.**
Originally a private set of scripts, I made the project evolve towards
a publically shareable set of tools that can be **easily used and even configured**
by anyone interested in using advanced development tools and in winning time.
It provides **many functions and shortcuts to ease Android development**.
* The sources written and shared here are either **meant to be used as they are**,
or to **serve as a reference for commands and functions** an Android developer needs.
**Developers or beginners** interested in shell commands and scripting
can look into my sources and find documented **commands and syntaxes**,
which can be used as a reference for shell scripting and help making their own.
---
### __How to update with upstream changes__ ###
* **To keep a local sync of 'advanced_development_shell_tools' updated with upstream changes**,
simply run the **`shtoolssync`** command and the updates will be downloaded.
Local modifications will be lost through the update (read about `git stash pop` in that case)
and the **newest commits / improvements will be added** to your available tools.
---
### __About the documentation and structure__ ###
* The linked **documentation holds a reference point to all functions and macros**
that this project provides, with details on their usage purpose,
and if present, the **`` or `[optional]` parameters** available.
* **The documentation is completely dynamically built.**
* Scripts flagged **"Standalone Import Ready"** and starting with **`source <(curl -Ls...`**
are able to be directly sourced through the provided commands in any terminal
**without the need of this project being installed locally** or loaded in the shell.
---
### __Project and documentations__ ###
* **Documentation and references :** [advanced_development_shell_tools](http://adriandc.github.io/advanced_development_shell_tools)
* **Sources on GitHub :** [advanced_development_shell_tools](https://github.com/AdrianDC/advanced_development_shell_tools)
---
### __How to install the project__ ###
* **Clone the project locally with git:**
*`git clone https://github.com/AdrianDC/advanced_development_shell_tools -b master`*
* **Load the project in the current Shell terminal:**
*`source /path/to/folder/advanced_development_shell_tools.rc`*
* **Permanently load the project:** Open *`~/.bashrc`*, adapt and add:
```Shell
export ANDROID_DEV_DRIVE='/media/../AndroidDev'
source '/.../advanced_development_shell_tools.rc'
```
* **The *`ANDROID_DEV_DRIVE`* variable** is a folder used for Android ROMs and kernels.
You do not *need* it, but a few functions rely on it to ease things.
---
### __How to contribute to the project__ ###
* Perform the **scripts modifications, fixes or additions**
* Validate the code thanks to ShellCheck with **`shtoolscheck`**
* Update README.md documentation with **`shtoolsreadme`**
* **Commit the changes** with git (refer to older commits for style)
* Push your changes and **create a pull-request** once ready
---
### __Project contributors and modules__ ###
* [AdrianDC](https://github.com/AdrianDC) : advanced_development_shell_tools creator and main developer
* [Caio99BR](https://github.com/Caio99BR) : advanced_development_shell_tools user and contributor
* [multirom-dev](https://github.com/multirom-dev/libbootimg/graphs/contributors) : libbootimg evolutions originally by [Tassadar](https://github.com/Tasssadar)
* [xiaolu](https://github.com/xiaolu/mkbootimg_tools) : mkbootimg_tools submodule original developer