From 036fa5a08dac68c69e80f3a4638baac77868359e Mon Sep 17 00:00:00 2001 From: "Haelwenn (lanodan) Monnier" Date: Mon, 4 Nov 2019 20:12:00 +0100 Subject: README.md: Update for current codebase status --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e06cfa8..baa5c4d 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,12 @@ The name is a reference to BBC’s Doctor Who Tv serie, I took it simply because Comparing from other small WebKit browsers for unixes found in the wild: - Independent of environment, should just work if GTK and WebKitGTK does +- Storing data should be: + - explicit and optionnal (ie. Applying preferences doesn't imply Saving to disk) + - 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 well under 1 000 lines +- Small codebase, right now we are under 1 500 lines total - Does not use modal editing (from vi) as that was designed for editing, not browsing - UTF-8 encoding by default @@ -23,11 +27,13 @@ Motivation from other clients , - Mirror: , this one can also be used if you prefer tickets/PRs over emails -### release tarballs +### release assets - Main: - Mirror: -Files ending in `.sig` are OpenPGP signatures done with my [key](https://hacktivis.me/key.asc)(`DDC9 237C 14CF 6F4D D847 F6B3 90D9 3ACC FEFF 61AE`). +- `*.tar.*` files are tarballs archives to be extracted with a program like `tar(1)`, GNU tar and LibArchive bsdtar are known to work. +- `*.sig` files are OpenPGP signatures done with my [key](https://hacktivis.me/key.asc)(`DDC9 237C 14CF 6F4D D847 F6B3 90D9 3ACC FEFF 61AE`). +- `*.sign` files are minisign (OpenBSD `signify(1)` compatible) signatures, they key used for it can be found at as well as other places (feel free to ping me to get it) ## Manual Installation Dependencies are: @@ -39,4 +45,4 @@ Dependencies are: Compilation is done with `make`, install with `make install`. An example AppArmor profile is provided at `usr.bin.badwolf`, please do runtime checks before deploying. ## 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. +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. -- cgit v1.3.1-23-gd82d