add readme file

lovelock · Apr 30, 2015 · 37bd14e · 37bd14e
1 parent e183888
commit 37bd14e
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# hackvim
+My own VIM configuration
+
+# 1. Installation
+### 1. clone the repo to your local disk
+```
+git clone https://github.com/lovelock/hackvim.git
+```
+
+### 2. go to the project directory and execute install.sh
+```
+cd /path/to/hackvim
+sh -x install.sh
+```
+
+### 3. enjoy it.
+
+# 2. Tips
+There maybe some problems in old Linux distributions, such as CentOS 5.5 or older, the you can checkout the server branch and use
+the non-YCM version. Believe me, the server branch is so good to improve your productity.
+```
+git checkout server
+```