summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
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