From: Daniel Carl <danielcarl@gmx.de>
Date: Thu, 11 May 2017 12:35:45 +0000 (+0200)
Subject: Updated README.
X-Git-Url: https://git.owens.tech/style.css/style.css/git?a=commitdiff_plain;h=67533d668cb8bde84d54c20f3e5de4c2e669de1f;p=vimb.git

Updated README.

Also added known packages.
---

diff --git a/README.md b/README.md
index ab7496d..cd0b464 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,56 @@
-# vimb - the vim like browser
+# Vimb - the Vim-like browser
 
-This is the development branch for the new webkit2 port of vimb. This branch
-does not work and lags a lot of features of the webkit1 version of vimb. So
-this is only meant to be the playground for the developers at the moment.
+Vimb is a Vim-like web browser that is inspired by Pentadactyl and Vimprobable.
+The goal of Vimb is to build a completely keyboard-driven, efficient and
+pleasurable browsing-experience with low memory and CPU usage that is
+intuitive to use for Vim users.
 
-If you like to have a working vimb, please use the master branch.
+More information and some screenshots of Vimb browser in action can be found on
+the project page of [Vimb][].
+
+## Features
+
+- it's modal like Vim
+- Vim like keybindings - assignable for each browser mode
+- nearly every configuration can be changed at runtime with Vim like set syntax
+- history for `ex` commands, search queries, URLs
+- completions for: commands, URLs, bookmarked URLs, variable names of settings, search-queries
+- hinting - marks links, form fields and other clickable elements to
+  be clicked, opened or inspected
+- SSL validation against ca-certificate file
+- user defined URL-shortcuts with placeholders
+- read it later queue to collect URIs for later use
+- multiple yank/paste registers
+
+## Packages
+
+- Gentoo [gentoo-git][], [gentoo][]
+
+## dependencies
+
+- webkit2gtk-4.0 >= 2.16.x
+
+## Install
+
+Edit `config.mk` to match your local setup.
+
+Edit `src/config.h` to match your 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 the following commands to compile and install Vimb (if necessary, the last one as
+root).
+
+    make
+    make install
+
+## Mailing list
+
+- feature requests, issues and patches can be discussed on the [mailing list][mail]
 
 ## Patching and Coding style
 
@@ -59,10 +105,6 @@ If you like to have a working vimb, please use the master branch.
         ├── scripts         JavaScripts that are compiled in for various purposes
         └── webextension    Source files for the webextension
 
-## dependencies
-
-- webkit2gtk-4.0 >= 2.3.5
-
 ## compile and run
 
 To inform vimb during compile time where the webextension should be loaded
@@ -76,6 +118,11 @@ To run vimb without installation you could run as a sandbox like this
 This will compile and install vimb into the local _sandbox_ folder in the
 project directory.
 
-# license
+## license
 
 Information about the license are found in the file LICENSE.
+
+[gentoo-git]:  https://github.com/tharvik/overlay/tree/master/www-client/vimb
+[gentoo]:      https://github.com/hsoft/portage-overlay/tree/master/www-client/vimb
+[vimb]:        https://fanglingsu.github.io/vimb/ "Vimb - Vim like browser project page"
+[mail]:        https://lists.sourceforge.net/lists/listinfo/vimb-users "vimb - mailing list"