badwolf

commit: 7e7de609f22e277778ce4d83cac236e6084bf065
parent: 39c7dc371bf8dbcc724e30d11c668cf7850d86f5
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date:   Thu, 14 Mar 2019 23:32:34 +0100

README.md: Add differencies, document installation

Diffstat:
M
README.md
21
+++++++++++++++++----

1 file changed, 17 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -5,15 +5,28 @@ SPDX-License-Identifier: BSD-3-Clause
 
 The name is a reference to BBC’s Doctor Who Tv serie, I took it simply because I wanted to have a specie in the name, like some other web browsers do, but doesn’t go into the “gentle” zone.
 
-Target: https://hacktivis.me/articles/www-client%20are%20broken
+## Differencies
+Comparing from other small WebKit browsers for unixes found in the wild:
+
+- Independent of environment, should just work if GTK and WebKitGTK does
+- Static UI, no element should be added at runtime, this is to avoid potential tracking via viewport changes
+- Small codebase, right now we are well under 1 000 lines
+- Does not use modal editing (from vi) as that was designed for editing, not browsing
+- UTF-8 encoding by default
+
+Motivation from other clients <https://hacktivis.me/articles/www-client%20are%20broken>
 
 ## Repositories
 - Main: <https://hacktivis.me/git/badwolf/>, <git://hacktivis.me/git/badwolf.git>
 - Mirror: <https://gitlab.com/lanodan/badWolf.git>, this one can also be used if you prefer tickets/PRs over emails
 
-## Dependencies
-- WebKitGTK+
-- GTK3+
+## Manual Installation
+Dependencies are:
+- [WebKitGTK](https://webkitgtk.org/), only the latest stable will be fully supported
+- C99+ Compiler (such as clang or gcc)
+- POSIX make (works with GNU or BSD)
+
+Compilation is done with `make`, install with `make install`.
 
 ## Notes
 Most of the privacy/security stuff will be done with patches against WebKit as quite a lot isn’t into [WebKitSettings](https://webkitgtk.org/reference/webkit2gtk/stable/WebKitSettings.html) and with a generic WebKit extension that should be resuseable.