X-Git-Url: https://git.armaanb.net/?p=chorizo.git;a=blobdiff_plain;f=README;h=373d692a0d7d09a965c3f75a23f2b5303f044a87;hp=d6bff5d5a655dff588322f4362a42363d3deca0d;hb=HEAD;hpb=15e4cb8ad0bcc9bc11a4470d1ae3bf93d16c05ae

diff --git a/README b/README
index d6bff5d..373d692 100644
--- a/README
+++ b/README
@@ -1,60 +1,108 @@
-zea - zeig's einfach an
-=======================
+        _                _
+    ___| |__   ___  _ __(_)_______
+   / __| '_ \ / _ \| '__| |_  / _ \
+  | (__| | | | (_) | |  | |/ / (_) |
+   \___|_| |_|\___/|_|  |_/___\___/
+  https://sr.ht/~armaan/chorizo
 
-zea is a minimalistic web browser using Gtk2, GLib and WebKit. "Zeig's
-einfach an" is german and translates roughly to "just show it" (the damn
-web page).
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+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.
 
-	- A WebKit viewport
-	- An input box to change the current URL
-	- Global content zoom
-	- Pluggability into suckless' tabbed
-	- vi-like scrolling (modified by CTRL)
-	- Searching the current page for a word
-	- Adblock
-	- Support for Flash and Java
+chorizo expects to be run on a POSIX-ish operating system.
 
-Planned features:
+To build and install the program:
 
-	- Keyword based searching (opening "wi foo" will search wikipedia)
+    $ make
+    # make install
 
 
-Using zea with tabbed
-====================
+Background information
+----------------------
 
-The order of arguments for zea doesn't matter. This means you can run it
-like this:
+What chorizo is and what it's not
 
-	$ tabbed -c ./zea file:///home/hans/bookmarks.html -z 0.8 -e
+  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.
 
-Each new tab will then show your bookmarks and is scaled by a factor of
-0.8.
+  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?
 
-Adblock
-=======
+  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.
 
-zea has built-in adblock functionality. In each line of
+  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
 
-	~/.config/zea/adblock.black
+Migrating from another browser
+------------------------------
 
-you can store a regular expression. These expressions match
-case-insensitive and partially, i.e. ".*foo.*" is the same as ".*FOO.*"
-and you can use anchors like "^https?://...".
+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.
 
-Literature
-==========
+  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.
 
-API references:
+From Firefox/Chromium/Brave/etc:
+  1. Set your expectations right. Read the background information
+  section of the README.
 
-	- http://webkitgtk.org/reference/webkitgtk/stable/index.html
-	- https://developer.gnome.org/gtk2/stable/index.html
-	- https://developer.gnome.org/glib/stable/index.html
+  2. Copy the cookie database into ~/.local/share/lariza/cookies.db.
 
-Regular expressions supported by GRegex, you can use these in your
-adblock patterns:
+  3. Read all the manpages.
 
-	- https://developer.gnome.org/glib/stable/glib-regex-syntax.html
+Copyright
+---------
+MIT License, see the LICENSE file for more information.