README

   1    _            _
   2   | | __ _ _ __(_)______ _
   3   | |/ _` | '__| |_  / _` |
   4   | | (_| | |  | |/ / (_| |
   5   |_|\__,_|_|  |_/___\__,_|
   6   https://uninformativ.de/git/lariza
   7   https://uninformativ.de/bugs.html
   8
   9
  10 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  11
  12
  13 A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
  14
  15 Features:
  16
  17     - A WebKit2 viewport
  18     - An input box to change the URI or to search the current page
  19     - Built-in download manager
  20     - Indicator for web feeds
  21     - Optimized hotkeys: Left hand on keyboard, right hand on mouse
  22     - Keyword based searching: Opening "wi foo" will search wikipedia
  23     - Global content zoom
  24     - Cooperative instances using FIFOs
  25     - Certificate trust store
  26     - Bundled user-supplied JavaScripts (optional):
  27         - Link hints
  28     - Bundled web extensions (optional):
  29         - Adblock
  30
  31
  32 Installation
  33 ------------
  34
  35 The following C libraries are required:
  36
  37     - GTK+ 3
  38     - WebKit2 API for GTK+ 3
  39
  40 lariza expects to be run on a POSIX-ish operating system.
  41
  42 To build the program and install it to /usr/local:
  43
  44     $ make
  45     # make install
  46
  47 To use bundled web extensions, they must be copied or symlinked to the
  48 appropriate path. Please refer to the manpage.
  49
  50
  51 Running
  52 -------
  53
  54 You simply invoke the main program:
  55
  56     $ lariza
  57
  58 Refer to the manpage for all options.
  59
  60
  61 Background information
  62 ----------------------
  63
  64  What lariza is and what it's not
  65
  66   lariza does what I need. It won't do other things. I'm open for pull
  67   requests but please don't be upset if I turn them down -- which might
  68   happen if it's a feature that I simply don't need. That being said,
  69   you should have a look at the PATCHES file. :-)
  70
  71   lariza does not compete with powerful browsers like dwb or luakit, nor
  72   with monstrous applications like Firefox or Chromium. lariza won't
  73   have persistent storage, nor a plugin system, nor cloud sync, nor
  74   bookmarks.
  75
  76
  77  About the name
  78
  79   "lariza" stems from a german sentence:
  80
  81       Alle anderen waren mir zu anstrengend.
  82        l   a         r    i  z  a
  83
  84   That phrase basically means: "It was too tiresome to deal with any
  85   other browser." I couldn't find a simple browser that does just what I
  86   need. Most of them are utterly bloated, others lack essential
  87   functions. Thus, I was forced to write scripts and tools and stuff to
  88   deal with these issues. That is what was tiresome. I don't want to
  89   work around bugs or nonsensical behavior anymore.
  90
  91   So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
  92   work.