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     - gst-libav, gst-plugins-good - for media playback
  38
  39 To generate the manpages, scdoc is required. This isn't necesary on
  40 release tarballs.
  41
  42 chorizo expects to be run on a POSIX-ish operating system.
  43
  44 To build and install the program:
  45
  46     $ make
  47     # make install
  48
  49
  50 Background information
  51 ----------------------
  52
  53 What chorizo is and what it's not
  54
  55   chorizo does what I need. It won't do other things. I'm open for
  56   contributions but please don't be upset if I turn them down -- which
  57   might happen if it's a feature that I simply don't need.
  58
  59   chorizo does not compete with powerful browsers like dwb or luakit, nor
  60   with monstrous applications like Firefox or Chromium. Because under
  61   the hood chorizo is powered by WebKit, however, it is on par with
  62   browsers like Safari for page rendering features.
  63
  64 How is chorizo related to lariza?
  65
  66   chorizo is a fork of the lariza browser by Peter Hofmann. I wanted
  67   to take it in a slightly different direction (mostly just adding
  68   features not considered to be in the spirit of lariza), so I forked
  69   it. The name was changed in order to reduce confusion between the
  70   two browsers as they grew apart. The versioning scheme was also
  71   moved away from being calendar-based.
  72
  73   Features that this fork has that lariza is missing:
  74     - Configuration file
  75     - Revamped download manager
  76     - New, ergonomic keybindings inspire by both Emacs and Vim
  77     - Better default directories
  78     - Easily togglable images and JavaScript
  79     - Cleaned up source code
  80     - Easy web searching
  81     - User stylesheet support
  82     - A variety of tweaks and adjustments that make the experience nicer
  83
  84 Migrating from another browser
  85 ------------------------------
  86
  87 From lariza:
  88   1. Copy the relevant paths from ~/.config/lariza to
  89   ~/.local/share/chorizo. Read chorizo(1) for full details on the
  90   correct paths.
  91
  92   2. Your symlinks from /usr will broken, so you should relink everything.
  93
  94   3. Read lariza-config(5), as the keybindings are radically different
  95   out of the box. Everything is configurable, however, and you can
  96   reconfigure the bindings to act just like your previous browser.
  97
  98 From Firefox/Chromium/Brave/etc:
  99   1. Set your expectations right. Read the background information
 100   section of the README.
 101
 102   2. Copy the cookie database into ~/.local/share/lariza/cookies.db.
 103
 104   3. Read all the manpages.
 105
 106 Copyright
 107 ---------
 108 MIT License, see the LICENSE file for more information.