logo

badwolf

minimalist and privacy-oriented web browser based on WebKitGTK git clone https://hacktivis.me/git/badwolf.git
commit: a451bce391119419b728a996c65c9066a7e280d8
parent 3521a35351f2173cca892a020b542b182a7cb5a9
Author: Oğuz Ersen <oguz@ersen.moe>
Date:   Sun, 23 Oct 2022 15:05:59 +0300

doc: fix typos

Diffstat:

MREADME.md12++++++------
Mdecisions.md12++++++------
2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md @@ -8,14 +8,14 @@ Minimalist and privacy-oriented WebKitGTK+ browser. Homepage: <https://hacktivis.me/projects/badwolf> -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. +The name is a reference to BBC's Doctor Who TV series, 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. -## Differencies +## Differences 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) + - explicit and optional (i.e. 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 @@ -52,8 +52,8 @@ You need to have gettext installed. If you want a GUI, poedit exists and Weblate ## Manual Installation ### Dependencies -- POSIX-compatible Shell (ie. mrsh, dash, lksh) -- POSIX-compatible make(1) (ie. {Free,Net,Open}BSD make, GNU make) +- POSIX-compatible Shell (i.e. mrsh, dash, lksh) +- POSIX-compatible make(1) (i.e. {Free,Net,Open}BSD make, GNU make) - A pkg-config implementation (pkgconf is recommended) - C11 Compiler (such as clang or gcc) - [WebKitGTK](https://webkitgtk.org/), only the latest stable(2.32.0+) is supported @@ -88,4 +88,4 @@ An example AppArmor profile is provided at `usr.bin.badwolf`, please do some lon If you modify the icons, you'll need `inkscape` (command line only), to regenerate the bitmap versions. It isn't needed for a normal installation as the bitmap icons are 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. +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 reusable. diff --git a/decisions.md b/decisions.md @@ -6,7 +6,7 @@ SPDX-License-Identifier: BSD-3-Clause # Decisions taken over the project lifetime ## What is this? See <https://akazlou.com/posts-output/2015-11-09-every-project-should-have-decisions/> -Bascially, the idea is to have a file in your projects repo, where you record +Basically, the idea is to have a file in your projects repo, where you record the decisions you make over the course of the project's lifetime. Rewriting history will not be done but Post-Scriptum notices will. @@ -32,9 +32,9 @@ I also decided to still release it in a point release, so without bump of Major Note: This would be an API if user-interface interactions could be scripted (like in HaikuOS) but I'm not aware of people actually doing this one with GTK programs. ## 2020-02-04 & 2020-02-09 : Use BSD extensions in the Makefile -The BSD extensions += and ?= for variable extension is used to avoid having to explicitely pass a list of variables to make, thus making build recipies simpler. +The BSD extensions += and ?= for variable extension is used to avoid having to explicitly pass a list of variables to make, thus making build recipes simpler. They are also compatible with GNU make so portability shouldn't have significantly dropped. -Which also meant dropping `.POSIX` into the file so `CC` wouldn't be set by default to `c99` (which isn't what I want, the codebase is in c11). +Which also meant dropping `.POSIX` into the file so `CC` wouldn't be set by default to `c99` (which isn't what I want, the codebase is in C11). ## 2020-01-30 02:59 : Make window declaration static This allows to avoid a quite useless memory allocation that would only be freed at the end of the program. @@ -53,7 +53,7 @@ From memory and git log: - The `.clang-format` file was copied from the one living in my home directory: - function declaration is at the start of the line to allow jumping to it with a simple editor - braces on their own lines to allow for comments space - - "tabs for indentation and space for alignement" style is used for flexibility + - "tabs for indentation and space for alignment" style is used for flexibility - mdoc was picked over other formats for the manpage, as it is implemented in mandoc and GNU groff, much simpler to read/write and transform to other formats (like HTML or Markdown). - Markdown was picked over other formats for informal documentation, it is a simple format supported by most forges, a format which is easier to write and parse could be considered - Proprietary systems are not supported for their lack of auditability and transparency. @@ -65,6 +65,6 @@ From memory and git log: - Writing a portable (almost POSIX-only) Makefile with `pkg-config(1)` was picked over other build systems which tend to be over-complicated and rely on only one implementation. - Originally the URL entry accepted only valid URLs, this was changed to a bit of heuristics for fixing it when it was entered by the user. - No search entry is provided, this is to encourage users to avoid search engines as much as possible, support for SmartBookmarks with keywords (similar to DuckDuckGo/Searx !bangs) will be added after support for suggestions via bookmarks -- Bookmarks are first-class citizens as they are data explicitely controlled by the user +- Bookmarks are first-class citizens as they are data explicitly controlled by the user - No browsing history is provided, this is to encourage to use and improve bookmarks, it will be added later on with data retention limits, ability to wipe it and non-reachable from WebKit (and so the Wild Web). -- Javascript is turned off by default with a checkbox to enable it temporarly, Permissions Requests (microphone, geolocation, …) are all denied, something similar to uMatrix and NoScript will eventually be done to fix this +- Javascript is turned off by default with a checkbox to enable it temporarily, Permissions Requests (microphone, geolocation, …) are all denied, something similar to uMatrix and NoScript will eventually be done to fix this