From 364428630de226be7d01e6a83bb742d49e5fa8ef Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Date: Wed, 31 Jul 2013 13:12:44 +0200 Subject: Updated the README --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b7231f..51e4610 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ # Yeah! just one letter ! -To do. +This repository holds a very humble and simple script that handles shortcuts +of bash paths. For example: + + $ g awesome + (instead of ...) + $ cd /home/user/directory/dir/awesome + +Furthermore, this repo also brings a file that adds bash completion so the user +can access the desired directory as fast as possible. In order to manage +shortcuts, this script accepts three commands: + + $ g add awesome /home/user/directory/dir/awesome + $ g rm awesome + $ g list + +I guess that the commands above are quite self-explanatory. + +# Install + +Just place the g.sh and the gcompletion.sh files wherever you want and then +add a "source" command for both of the files in the .bashrc file. # Legal stuff -- cgit v1.2.3