X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README;h=8c85e3b81528803b4420f0bef2fc20e33f9d1b60;hb=f4d5f98aa3341cf9c01ba3d9d74e2dedbafe7fe3;hp=7702fcc9c6303ced7775fe6d6c39927def082fcc;hpb=61013e58b980b940e0434250318faa6ed084892b;p=chorizo.git

diff --git a/README b/README
index 7702fcc..8c85e3b 100644
--- a/README
+++ b/README
@@ -1,40 +1,92 @@
-sn - sonst nix
-==============
+   _            _
+  | | __ _ _ __(_)______ _
+  | |/ _` | '__| |_  / _` |
+  | | (_| | |  | |/ / (_| |
+  |_|\__,_|_|  |_/___\__,_|
+  https://uninformativ.de/git/lariza
+  https://uninformativ.de/bugs.html
 
-This is a minimalistic web browser using Gtk2 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 WebKit viewport
-	- Global content zoom
-	- Pluggability into suckless' tabbed
-	- Support for Flash and Java
+    - A WebKit2 viewport
+    - An input box to change the URI or to search the current page
+    - Built-in download manager
+    - Indicator for web feeds
+    - Optimized hotkeys: Left hand on keyboard, right hand on mouse
+    - Keyword based searching: Opening "wi foo" will search wikipedia
+    - Global content zoom
+    - Cooperative instances using FIFOs
+    - Certificate trust store
+    - Bundled user-supplied JavaScripts (optional):
+        - Link hints
+    - Bundled web extensions (optional):
+        - Adblock
+
+
+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.
 
-Planned features:
 
-	- An input box to change the current URL
-	- vi-like shortcuts
-	- Adblock
+Background information
+----------------------
 
+ What lariza is and what it's not
 
-Using sn with tabbed
-====================
+  lariza does what I need. It won't do other things. I'm open for pull
+  requests 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. That being said,
+  you should have a look at the PATCHES file. :-)
 
-The order of arguments for sn doesn't matter. This means you can run it
-like this:
+  lariza does not compete with powerful browsers like dwb or luakit, nor
+  with monstrous applications like Firefox or Chromium. lariza won't
+  have persistent storage, nor a plugin system, nor cloud sync, nor
+  bookmarks.
 
-	$ tabbed -c ./sn file:///home/hans/bookmarks.html -z 0.8 -e
 
-Each new tab will then show your bookmarks and is scaled by a factor of
-0.8.
+ About the name
 
+  "lariza" stems from a german sentence:
 
-Literature
-==========
+      Alle anderen waren mir zu anstrengend.
+       l   a         r    i  z  a
 
-API references:
+  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.
 
-	- http://webkitgtk.org/reference/webkitgtk/stable/index.html
-	- https://developer.gnome.org/gtk2/stable/index.html
+  So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
+  work.