X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README;h=cc0145ed0e69ecdffec7e22c0cd311837ff73e1a;hb=41afaa44290fce503ac8cf00156a7b8de8e680e3;hp=0d91d11e431243056d933e3d4e4c080e7e58b27c;hpb=76edc528c4245391b53a08a8fb56cfdba926e57d;p=chorizo.git

diff --git a/README b/README
index 0d91d11..cc0145e 100644
--- a/README
+++ b/README
@@ -1,36 +1,86 @@
-sn - sonst nix
-==============
+   _            _
+  | | __ _ _ __(_)______ _
+  | |/ _` | '__| |_  / _` |
+  | | (_| | |  | |/ / (_| |
+  |_|\__,_|_|  |_/___\__,_|
+  https://sr.ht/~armaan/lariza
 
-This is a minimalistic web browser using Gtk3 and WebKit. "Sonst nix" is
-german and translates roughly to "nothing else". sn is simple and meant
-to stay simple.
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 
 Features:
+    - A WebKit2 viewport
+    - An input box to change the URI or to search the current page
+    - Built-in download manager
+    - Indicator for web feeds
+    - Full keyboard control
+    - Global content zoom
+    - Cooperative instances using FIFOs
+    - Certificate trust store
+    - User script support
+    - Extension support
+
+Installation
+------------
+
+The following C libraries are required:
+
+    - GTK+ 3
+    - WebKit2 API for GTK+ 3
+
+lariza expects to be run on a POSIX-ish operating system.
+
+To build the program and install it to /usr/local:
+
+    $ make
+    # make install
+
+To use bundled web extensions, they must be copied or symlinked to the
+appropriate path. Please refer to the manpage.
+
+
+Running
+-------
+
+You simply invoke the main program:
+
+    $ lariza
+
+Refer to the manpage for all options.
+
+
+Background information
+----------------------
 
-	- A WebKit viewport
-	- Global content zoom
+ What lariza is and what it's not
 
-Planned features:
+  lariza does what I need. It won't do other things. I'm open for
+  contributions but please don't be upset if I turn them down -- which
+  might happen if it's a feature that I simply don't need.
 
-	- An input box to change the current URL
-	- vi-like shortcuts
-	- Adblock
-	- Pluggability into suckless' tabbed (preferred) or native tabs
+  lariza does not compete with powerful browsers like dwb or luakit, nor
+  with monstrous applications like Firefox or Chromium.
 
+ About the name
 
-Why WebKit instead of WebKit2?
-==============================
+  "lariza" stems from a german sentence:
 
-While WebKit2 has fancy process separation and all that stuff, it turned
-out to be pretty slow and clunky. Plus, ideally, sn will be plugged into
-suckless' tabbed -- so it wouldn't benefit from process separation
-anyway.
+      Alle anderen waren mir zu anstrengend.
+       l   a         r    i  z  a
 
+  That phrase basically means: "It was too tiresome to deal with any
+  other browser." I couldn't find a simple browser that does just what I
+  need. Most of them are utterly bloated, others lack essential
+  functions. Thus, I was forced to write scripts and tools and stuff to
+  deal with these issues. That is what was tiresome. I don't want to
+  work around bugs or nonsensical behavior anymore.
 
-Literature
-==========
+  So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
+  work.
 
-API references:
+Copyright
+---------
+MIT License, see the LICENSE file for more information.
 
-	- http://webkitgtk.org/reference/webkitgtk/stable/index.html
-	- https://developer.gnome.org/gtk3/stable/index.html
+This codebase is a fork of the original lariza browser by Peter Hofmann.
\ No newline at end of file