mcy
/
scripts
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Convert README to Markdown (README.md)

This commit is contained in:
Matteo Cypriani 2016-11-01 16:34:23 -04:00
parent 88ea67d493
commit 514c044088
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README → README.md
View File

@ -4,17 +4,17 @@ the license and copyright information of a script are given in the
file's header.
The scripts are categorised into directories, and each directory
contains a README file with description and usage of each script it
contains a `README` file with description and usage of each script it
contains.
For convenience, the bin/ directory is maintained with symbolic links
For your convenience, the `bin/` directory is maintained with symbolic links
pointing to the scripts in the other directories, so that you can add it
to your PATH and use the scripts easily. The file extensions (.sh, .pl,
.py, etc.) are stripped. Only relevant scripts are linked, i.e. those
to your PATH and use the scripts easily. The file extensions (`.sh`, `.pl`,
`.py`, etc.) are stripped. Only relevant scripts are linked, i.e. those
that do not need to be customised in order to be usable, and that are
not very specialised system administration scripts.
To use the bin/ directory, add something like that in your .bashrc,
.zshrc or whatever file the shell you're using will source:
To use the `bin/` directory, add something like that in your `.bashrc`,
`.zshrc` or whatever file the shell you're using will source:
PATH="$HOME/path/to/scripts/bin:$PATH"
PATH="$HOME/path/to/scripts/bin:$PATH"