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 launching of suckless' tabbed
  20     - Built-in download manager
  21     - Indicator for web feeds
  22     - Optimized hotkeys: Left hand on keyboard, right hand on mouse
  23     - Keyword based searching: Opening "wi foo" will search wikipedia
  24     - Global content zoom
  25     - Cooperative instances using FIFOs
  26     - Certificate trust store
  27     - Bundled web extensions:
  28         - Adblock
  29
  30
  31 Installation
  32 ------------
  33
  34 The following C libraries are required:
  35
  36     - GTK+ 3
  37     - WebKit2 API for GTK+ 3
  38
  39 lariza expects to be run on a POSIX-ish operating system.
  40
  41 To build the program and install it to /usr/local:
  42
  43     $ make
  44     # make install
  45
  46 To use bundled web extensions, they must be copied or symlinked to the
  47 appropriate path. Please refer to the manpage.
  48
  49
  50 Running
  51 -------
  52
  53 You simply invoke the main program:
  54
  55     $ lariza
  56
  57 Refer to the manpage for all options.
  58
  59
  60 Background information
  61 ----------------------
  62
  63  What lariza is and what it's not
  64
  65   lariza does what I need. It won't do other things. I'm open for pull
  66   requests but please don't be upset if I turn them down -- which might
  67   happen if it's a feature that I simply don't need. That being said,
  68   you should have a look at the PATCHES file. :-)
  69
  70   Especially, it's very likely that lariza will never have a "follow
  71   mode" like dwb, luakit or others have. I've used these browsers for
  72   quite some time and I've also used Firefox extensions that add a
  73   "follow mode". The point is, "follow mode" doesn't work anymore. This
  74   was a good thing ten years ago. Today, a lot of websites make heavy
  75   use of JavaScript or hovering. You NEED some kind of pointing device.
  76   I found using "follow mode" to be very frustrating today, because you
  77   still have to reach for the mouse all the time. So, you might as well
  78   just optimize your mousing workflow.
  79
  80   lariza does not compete with powerful browsers like dwb or luakit, nor
  81   with monstrous applications like Firefox or Chromium. lariza won't
  82   have persistent storage, nor a plugin system, nor cloud sync, nor
  83   bookmarks.
  84
  85   lariza tries not to exceed 1000 lines of code.
  86
  87
  88  About the name
  89
  90   "lariza" stems from a german sentence:
  91
  92       Alle anderen waren mir zu anstrengend.
  93        l   a         r    i  z  a
  94
  95   That phrase basically means: "It was too tiresome to deal with any
  96   other browser." I couldn't find a simple browser that does just what I
  97   need. Most of them are utterly bloated, others lack essential
  98   functions. Thus, I was forced to write scripts and tools and stuff to
  99   deal with these issues. That is what was tiresome. I don't want to
 100   work around bugs or nonsensical behavior anymore.
 101
 102   So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
 103   work.