aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 270fdb7e61228705b41751cb24e540123bc45d8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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-2023 Miquel Sabaté Solà <mikisabate@gmail.com>

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 <http://www.gnu.org/licenses/>.
#+END_SRC