From bb2caaa92a4096fb13a0e16ac601b98d7a3b7c24 Mon Sep 17 00:00:00 2001
From: Mathieu Maret <mmaret@genymobile.com>
Date: Wed, 3 Feb 2016 17:21:51 +0100
Subject: [PATCH] Complete documentation

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e2cf3d7..7e55db7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
+# Developers Tools
+
+This repo contains a set of tools and configuration files used for development.
+Especially for Android Rom development
+
+## Install tool
 First get git submodule:
-git submodule update --init
\ No newline at end of file
+```
+git submodule update --init
+```
+
+then you can use the vim configuration file
+```
+ ln -s PATH_TO_THIS_REPO/.vim ~/.vim
+ ln -s PATH_TO_THIS_REPO/.vimrc ~/.vimrc
+```
+
+copy tools/aosp_cscope in your PATH
+
+source shell/function.sh in your bashrc or zshrc or ...
+
+## Vim
+
+Vim plugins are managed by vundle. So at first lunch you have to run in vim
+```
+ :PluginInstall
+```
+
+