diff --git a/README.md b/README.md index 383e86c..7909142 100644 --- a/README.md +++ b/README.md @@ -1 +1,64 @@ +# shell-tools + A collection of shell functions and tools I am using. + +## Synopsis + +Put the files under a directory in your ``${HOME}`` e.g. ``${HOME}/scripts``. +Then add in your shell profile the following lines: + + . ${HOME}/scripts/init/tmp.sh + . ${HOME}/scripts/init/keymanagement.sh + . ${HOME}/scripts/init/tools.sh + . ${HOME}/scripts/init/vcs.sh + + ssh-init-agent + gpg-init-agent + +## Description + +After you added the lines above and source your shell profile you got a whole +bunch of shell functions for various tasks. + +Well, the ssh and gpg keys need to be in a valid place and there are also +other requirements. + +**TODO** Write a description for all and everything... + +## Requirements + + * Tested with bash but might work with other shells as well. + +## Dependencies + +The is a huge list of dependencies. Some that come in my mind are: + + * GnuPG + * OpenSSH + * ImageMagick + * GnuCal + * Conky + * most likely lots of others... + +## Contributing + +Just write me an email. + +## License + + 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 . + +## Author + +Georg Hopp