From d27adea3d658ce086e6f08c2a518dacdc966289f Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Tue, 23 Dec 2014 18:50:21 +0100 Subject: README: describe the installation process in the README file Signed-off-by: Olivier Gayot --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md 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 -- cgit v1.2.3