diff options
| author | Olivier Gayot <duskcoder@gmail.com> | 2014-12-23 18:50:21 +0100 |
|---|---|---|
| committer | Olivier Gayot <duskcoder@gmail.com> | 2014-12-23 18:50:21 +0100 |
| commit | d27adea3d658ce086e6f08c2a518dacdc966289f (patch) | |
| tree | f3e92fe3b82220d4b7f297266c16053a7e43141b | |
| parent | 02d5e9e871bf7501989ad4e8956da31fb9c8f302 (diff) | |
README: describe the installation process in the README file
Signed-off-by: Olivier Gayot <duskcoder@gmail.com>
| -rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f7e1c3 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +camelconf +========= + +description +----------- + +Setup and install my default configuration for tools including: +* vim +* zsh +* vimperator +* git +* wmii +* X resources +* xinit + +dependencies +------------ + +In order to use this software, you need Git and Python. + +usage +----- + +The simplest way is to use the install.sh script. It will fetch any other +needed repository and then install every configuration file for either the +current user or globally (requires root privileges). + + $ ./install.sh user + +or/and + + $ [sudo] ./install.sh global |