summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Carl <danielcarl@gmx.de>2017-06-14 23:53:18 +0200
committerDaniel Carl <danielcarl@gmx.de>2017-06-14 23:53:18 +0200
commit17991ee34e7893c3f39e874c85832dc8bf2002bb (patch)
tree1c1da23ddb40f398039e9b5213988ef3c41ae98d /CONTRIBUTING.md
parentbdfeeb72e7fed0f5f62c4d6c8bf779923254f445 (diff)
Added goals to CONTRIBUTING file.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dbb78f9..a7305db 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,6 +3,18 @@
This document contains guidelines for contributing to vimb, as well as useful
hints when doing so.
+## Goals
+
+Getting a light, fast and keyboard-driven browser that is easy to use for
+those users familiar with vim.
+
+- Provide powerful knobs allowing the user to tweak vimb to fit the own needs
+ and usecases.
+- Add only knobs/features that do not do what other knobs do. In this point
+ vimb is in contrast to vim.
+- If there are two colliding features we should pick the mightier one, or that
+ which need less code or resources.
+
## Communication
If you want to discuss some feature or provide some suggestion that can't be
@@ -60,7 +72,7 @@ github for that.
├── doc documentation like manual page
└── src all sources to build vimb
- ├── scripts JavaScripts that are compiled in for various purposes
+ ├── scripts JavaScripts and CSS that are compiled in for various purposes
└── webextension Source files for the webextension
## compile and run