add proper README

This commit is contained in:
Ville Rantanen
2016-03-08 14:38:32 +02:00
parent f17a2011bf
commit 1538aa9bcd

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# Shell Tools package
This is a growing selection of shell tools used by me and my colleagues.
Each tool is an individual program, which do often depend on other tools.
Dependencies are best found by running the programs.
To see the help page of each tool, run the ./README script
## Installation
`hg clone https://bitbucket.org/MoonQ/tools`
`. tools/rc`
It is best to add the second line, sourcing the rc file in your .bashrc