draft 8

[chorizo.git] / README

diff --git a/README b/README
index 056fe1f19e560931665ce394b426f8a161e95f11..a42cedd3563e14239cb34ea0e32b946557440bb7 100644 (file)
--- a/README
+++ b/README
@@ -1,42 +1,50 @@
-zea - zeig's einfach an
-=======================
+chorizo
+======
 
-zea is a minimalistic web browser using Gtk2 and WebKit. "Zeig's einfach
-an" is german and translates roughly to "just show it" (the damn web
-page).
+http://armaanb.net/chorizo.html
 
-Features:
+A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 
-       - 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
-       - Support for Flash and Java
+Refer to the manpages chorizo(1), and chorizo-usage(1) for more information.
 
-Planned features:
+Installation
+------------
 
-       - Adblock
-       - Keyword based searching (opening "wi foo" will search wikipedia)
+The following C libraries are required:
 
+    - GTK+ 3
+    - WebKit2 API for GTK+ 3
+    - gst-libav, gst-plugins-good (for media playback)
 
-Using zea with tabbed
-====================
+The following programs are required:
+    - A C compiler supporting C11
+    - make
+    - pkg-config
 
-The order of arguments for zea doesn't matter. This means you can run it
-like this:
+chorizo expects to be run on a POSIX-ish operating system.
 
-       $ tabbed -c ./zea file:///home/hans/bookmarks.html -z 0.8 -e
+To build and install the program:
 
-Each new tab will then show your bookmarks and is scaled by a factor of
-0.8.
+    $ make
+    # make install
 
 
-Literature
-==========
+How is chorizo related to lariza?
+---------------------------------
 
-API references:
+  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.
 
-       - http://webkitgtk.org/reference/webkitgtk/stable/index.html
-       - https://developer.gnome.org/gtk2/stable/index.html
+  Differences:
+    - New versioning scheme
+    - Revamped download manager
+    - New keybindings
+    - Better default directories
+    - Easily togglable JavaScript
+    - Cleaned up source code
+    - Easy web searching
+    - User stylesheet support
+    - A variety of tweaks and adjustments that make the experience nicer