From: Daniel Carl <danielcarl@gmx.de>
Date: Tue, 30 Jul 2013 12:55:39 +0000 (+0200)
Subject: Updated README file.
X-Git-Url: https://git.owens.tech/assets/lich_lifts_title_slice.png/assets/lich_lifts_title_slice.png/git?a=commitdiff_plain;h=7eeca27bb126e8541ae0fa8bb4b3a2ee10d979bd;p=vimb.git

Updated README file.
---

diff --git a/README.md b/README.md
index bbbbed8..d90cd19 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ the [vimb project page][vimb].
 - completions for
   - commands
   - urls
+  - bookmarked urls
   - variable names of settings
   - search-queries
 - hinting - marks links, form fields and other clickable elements to be
@@ -31,15 +32,32 @@ the [vimb project page][vimb].
   other fat browsers
 - ssl validation against ca-certificate file
 - custom configuration files
-- tagged bookmarks
 - open input or textarea with configurable external editor
 - user defined URL-shortcuts with placeholders
+- run shell commands from inpubox
 
 ## dependencies
 - libwebkit >=1.3.10
 - libgtk+-2.0
 - libsoup-2.4
 
+## install
+Edit config.mk to match your local setup.
+
+Edit config.h to match you personal preferences.
+
+The default Makefile will not overwrite your customised `config.h` with the
+contents of `config.def.h`, even if it was updated in the latest git pull.
+Therefore, you should always compare your customised `config.h` with
+`config.def.h` and make sure you include any changes to the latter in your
+`config.h`.
+
+Run following command to compile and install vimb (if necessary last one as
+root).
+
+    make clean && make
+    make install
+
 # license
 Information about the license are found in the file LICENSE.