Summary Files Commits Branches @commit @diff @stats
path: root / README.md
diff options
context:
space:
mode:
1 files changed, 4 insertions, 2 deletions
-rw-r--r--README.md6
diff --git a/README.md b/README.md
index 6ce8eef..22846e1 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Comparing from other small WebKit browsers for unixes found in the wild:
- not queryabe by WebKit (so the web can't use it)
- done in a standard format (like XBEL for bookmarks)
- Static UI, no element should be added at runtime, this is to avoid potential tracking via viewport changes
-- Small codebase, right now we are under 1 500 lines total
+- Small codebase, should be possible to read and understand it completely over an afternoon.
- Does not use modal editing (from vi) as that was designed for editing, not browsing
- UTF-8 encoding by default
@@ -54,7 +54,9 @@ Dependencies are:
- A pkg-config implementation (pkgconf is recommended)
- (optionnal) gettext implementation (such as GNU Gettext)
-Compilation is done with `make CC=${CC:-cc}`, install with `make install`. An example AppArmor profile is provided at `usr.bin.badwolf`, please do runtime checks before deploying.
+Compilation is done with `make`, install with `make install` (`DESTDIR` and `PREFIX` environment variables are supported, amongs other common ones). An example AppArmor profile is provided at `usr.bin.badwolf`, please do some long runtime checks before shipping it or a modified version, help can be provided but with no support.
+
+You'll also need `rsvg-convert(1)` (from librsvg) and scour if you want to regenerate the icons, for example after modifying them or adding a new size. These aren't needed for normal installation as it is bundled.
## 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 generic WebKit extensions that should be resuseable.