From ecdc723c96e0a92fdda3a754edb0302cdc2de9eb Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Tue, 17 Mar 2020 17:24:58 +0100 Subject: Rebumped the whole project so it's better looking MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I've also added the `git-validation` tool into the test suite. Signed-off-by: Miquel Sabaté Solà --- README.org | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 README.org (limited to 'README.org') diff --git a/README.org b/README.org new file mode 100644 index 0000000..78198fb --- /dev/null +++ b/README.org @@ -0,0 +1,67 @@ +* Yeah! just one letter ! +[[https://travis-ci.org/mssola/g][https://travis-ci.org/mssola/g.svg?branch=master]] + +This repository holds a very humble and simple script that handles shortcuts of +bash paths. For example: + +#+BEGIN_SRC bash +$ g awesome +# instead of ... +$ cd /home/user/directory/dir/awesome +#+END_SRC + +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: + +#+BEGIN_SRC bash +$ g add awesome /home/user/directory/dir/awesome +$ g list +# Output: +# awesome => /home/user/directory/dir/awesome +$ cd /home/user/directory/anotherawesome +$ g add anotherawesomedir +$ g rm awesome +$ g list +# Output: +# anotherawesome => /home/user/directory/anotherawesome +#+END_SRC + +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. + +** GNU Emacs + +I have also created a package for GNU Emacs and it is available on my [[https://github.com/mssola/dotfiles/blob/master/.emacs.d/lisp/g.el][dotfiles]] +project. + +** Contributing + +Read the [[./CONTRIBUTING.org][CONTRIBUTING.org]] file. + +** [[https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small][Changelog]] + +Read the [[./CHANGELOG.org][CHANGELOG.org]] file. + +** Legal stuff + +#+BEGIN_SRC text +Copyright (C) 2013-2020 Miquel Sabaté Solà + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +#+END_SRC -- cgit v1.2.3