_                _
    ___| |__   ___  _ __(_)_______
   / __| '_ \ / _ \| '__| |_  / _ \
  | (__| | | | (_) | |  | |/ / (_) |
   \___|_| |_|\___/|_|  |_/___\___/
  https://sr.ht/~armaan/chorizo

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A simple web browser using GTK+ 3, GLib and WebKit2GTK+.

Features:
    - A WebKit2 viewport
    - An input box to change the URI, search the current page, or
      search the web
    - Tab management
    - Full keyboard control
    - An ini configuration file
    - Built-in download manager
    - Web feeds indicator
    - Global content zoom
    - Cooperative instances using FIFOs
    - Certificate trust store
    - User script support
    - Extensions

Refer to the manpages chorizo(1), chorizo-usage(1), and
chorizo-config(5), for more information.

Installation
------------

The following C libraries are required:

    - GTK+ 3
    - WebKit2 API for GTK+ 3
    - gst-libav, gst-plugins-good - for media playback

To generate the manpages, scdoc is required. This isn't necesary on
release tarballs.

chorizo expects to be run on a POSIX-ish operating system.

To build and install the program:

    $ make
    # make install


Background information
----------------------

What chorizo is and what it's not

  chorizo does what I need. It won't do other things. I'm open for
  contributions 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.

  chorizo does not compete with powerful browsers like dwb or luakit, nor
  with monstrous applications like Firefox or Chromium. Because under
  the hood chorizo is powered by WebKit, however, it is on par with
  browsers like Safari for page rendering features.

How is chorizo related to lariza?

  chorizo is a fork of the lariza browser by Peter Hofmann. I wanted
  to take it in a slightly different direction (mostly just adding
  features not considered to be in the spirit of lariza), so I forked
  it. The name was changed in order to reduce confusion between the
  two browsers as they grew apart. The versioning scheme was also
  moved away from being calendar-based.

  Features that this fork has that lariza is missing:
    - Configuration file
    - Revamped download manager
    - New, ergonomic keybindings inspire by both Emacs and Vim
    - Better default directories
    - Easily togglable images and JavaScript
    - Cleaned up source code
    - Easy web searching
    - User stylesheet support
    - A variety of tweaks and adjustments that make the experience nicer

Migrating from another browser
------------------------------

From lariza:
  1. Copy the relevant paths from ~/.config/lariza to
  ~/.local/share/chorizo. Read chorizo(1) for full details on the
  correct paths.

  2. Your symlinks from /usr will broken, so you should relink everything.

  3. Read lariza-config(5), as the keybindings are radically different
  out of the box. Everything is configurable, however, and you can
  reconfigure the bindings to act just like your previous browser.

From Firefox/Chromium/Brave/etc:
  1. Set your expectations right. Read the background information
  section of the README.

  2. Copy the cookie database into ~/.local/share/lariza/cookies.db.

  3. Read all the manpages.

Copyright
---------
MIT License, see the LICENSE file for more information.