From 181863af1d359e5f7484300ce7f9c3729ecc0986 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Wed, 16 Dec 2020 20:36:48 +0200 Subject: [PATCH] docs: Add simple installation instructions to readme This will help newcomers, and not confuse them by redirecting them to another site instantly. --- docs/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 381af07e..23b765a7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) - [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) - [via Docker](https://bash-it.readthedocs.io/en/latest/installation/#install-using-docker) - [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) - [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 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.