XorA
/
bash-it
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add simple installation instructions to readme 

This will help newcomers, and not confuse them by redirecting them to
another site instantly.
pull/1747/head
Noah Gorny 2020-12-16 20:36:48 +02:00
parent 859038e58f
commit 181863af1d
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.md
View File

@ -14,7 +14,7 @@ Stop polluting your `~/bin` directory and your `.bashrc` file, fork/clone Bash-i
- [Main Page](https://bash-it.readthedocs.io/en/latest) - [Main Page](https://bash-it.readthedocs.io/en/latest)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Installation](https://bash-it.readthedocs.io/en/latest/installation) - [Installation](#installation)
- [Install Options](https://bash-it.readthedocs.io/en/latest/installation/#install-options) - [Install Options](https://bash-it.readthedocs.io/en/latest/installation/#install-options)
- [via Docker](https://bash-it.readthedocs.io/en/latest/installation/#install-using-docker) - [via Docker](https://bash-it.readthedocs.io/en/latest/installation/#install-using-docker)
- [Updating](https://bash-it.readthedocs.io/en/latest/installation/#updating) - [Updating](https://bash-it.readthedocs.io/en/latest/installation/#updating)
@ -33,6 +33,17 @@ Stop polluting your `~/bin` directory and your `.bashrc` file, fork/clone Bash-i
- [Help Out](https://bash-it.readthedocs.io/en/latest/#help-out) - [Help Out](https://bash-it.readthedocs.io/en/latest/#help-out)
- [Contributors](#contributors) - [Contributors](#contributors)
## Installation
1) Check out a clone of this repo to a location of your choice, such as
``git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it``
2) Run ``~/.bash_it/install.sh``
Thats it! :smiley:
You can check out more components of Bash-it, and customize it to your desire.
For more information, see detailed instructions [here](https://bash-it.readthedocs.io/en/latest/installation/).
## Contributing ## Contributing
Please take a look at the [Contribution Guidelines](https://bash-it.readthedocs.io/en/latest/contributing) before reporting a bug or providing a new feature. Please take a look at the [Contribution Guidelines](https://bash-it.readthedocs.io/en/latest/contributing) before reporting a bug or providing a new feature.