README

   1         _                _
   2     ___| |__   ___  _ __(_)_______
   3    / __| '_ \ / _ \| '__| |_  / _ \
   4   | (__| | | | (_) | |  | |/ / (_) |
   5    \___|_| |_|\___/|_|  |_/___\___/
   6   https://sr.ht/~armaan/chorizo
   7
   8 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   9
  10 A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
  11
  12 Features:
  13     - A WebKit2 viewport
  14     - An input box to change the URI, search the current page, or
  15       search the web
  16     - Tab management
  17     - Full keyboard control
  18     - An ini configuration file
  19     - Built-in download manager
  20     - Web feeds indicator
  21     - Global content zoom
  22     - Cooperative instances using FIFOs
  23     - Certificate trust store
  24     - User script support
  25     - Extensions
  26
  27 Refer to the manpages chorizo(1), chorizo-usage(1), and
  28 chorizo-config(5), for more information.
  29
  30 Installation
  31 ------------
  32
  33 The following C libraries are required:
  34
  35     - GTK+ 3
  36     - WebKit2 API for GTK+ 3
  37
  38 To generate the manpages, scdoc is required. This isn't necesary on
  39 release tarballs.
  40
  41 chorizo expects to be run on a POSIX-ish operating system.
  42
  43 To build and install the program:
  44
  45     $ make
  46     # make install
  47
  48
  49 Background information
  50 ----------------------
  51
  52 What chorizo is and what it's not
  53
  54   chorizo does what I need. It won't do other things. I'm open for
  55   contributions but please don't be upset if I turn them down -- which
  56   might happen if it's a feature that I simply don't need.
  57
  58   chorizo does not compete with powerful browsers like dwb or luakit, nor
  59   with monstrous applications like Firefox or Chromium. Because under
  60   the hood chorizo is powered by WebKit, however, it is on par with
  61   browsers like Safari for page rendering features.
  62
  63 How is chorizo related to lariza?
  64
  65   chorizo is a fork of the lariza browser by Peter Hofmann. I wanted
  66   to take it in a slightly different direction (mostly just adding
  67   features not considered to be in the spirit of lariza), so I forked
  68   it. The name was changed in order to reduce confusion between the
  69   two browsers as they grew apart. The versioning scheme was also
  70   changed from being calendar-based to following the semantic
  71   versioning scheme.
  72
  73
  74 Copyright
  75 ---------
  76 MIT License, see the LICENSE file for more information.