From 514c044088ee6c9c2012d5b7852e43522b839946 Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Tue, 1 Nov 2016 16:34:23 -0400 Subject: [PATCH] Convert README to Markdown (README.md) --- README => README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename README => README.md (51%) diff --git a/README b/README.md similarity index 51% rename from README rename to README.md index b9677e5..b6bfd5c 100644 --- a/README +++ b/README.md @@ -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"