draft 8

[chorizo.git] / README

diff --git a/README b/README
index cc0145ed0e69ecdffec7e22c0cd311837ff73e1a..a42cedd3563e14239cb34ea0e32b946557440bb7 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,11 @@
-   _            _
-  | | __ _ _ __(_)______ _
-  | |/ _` | '__| |_  / _` |
-  | | (_| | |  | |/ / (_| |
-  |_|\__,_|_|  |_/___\__,_|
-  https://sr.ht/~armaan/lariza
+chorizo
+======
 
-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+http://armaanb.net/chorizo.html
 
 A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
 
-Features:
-    - A WebKit2 viewport
-    - An input box to change the URI or to search the current page
-    - Built-in download manager
-    - Indicator for web feeds
-    - Full keyboard control
-    - Global content zoom
-    - Cooperative instances using FIFOs
-    - Certificate trust store
-    - User script support
-    - Extension support
+Refer to the manpages chorizo(1), and chorizo-usage(1) for more information.
 
 Installation
 ------------
@@ -28,59 +14,37 @@ The following C libraries are required:
 
     - GTK+ 3
     - WebKit2 API for GTK+ 3
+    - gst-libav, gst-plugins-good (for media playback)
 
-lariza expects to be run on a POSIX-ish operating system.
+The following programs are required:
+    - A C compiler supporting C11
+    - make
+    - pkg-config
 
-To build the program and install it to /usr/local:
+chorizo expects to be run on a POSIX-ish operating system.
+
+To build and install the program:
 
     $ make
     # make install
 
-To use bundled web extensions, they must be copied or symlinked to the
-appropriate path. Please refer to the manpage.
-
-
-Running
--------
-
-You simply invoke the main program:
-
-    $ lariza
-
-Refer to the manpage for all options.
-
-
-Background information
-----------------------
-
- What lariza is and what it's not
-
-  lariza 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.
-
-  lariza does not compete with powerful browsers like dwb or luakit, nor
-  with monstrous applications like Firefox or Chromium.
-
- About the name
-
-  "lariza" stems from a german sentence:
-
-      Alle anderen waren mir zu anstrengend.
-       l   a         r    i  z  a
-
-  That phrase basically means: "It was too tiresome to deal with any
-  other browser." I couldn't find a simple browser that does just what I
-  need. Most of them are utterly bloated, others lack essential
-  functions. Thus, I was forced to write scripts and tools and stuff to
-  deal with these issues. That is what was tiresome. I don't want to
-  work around bugs or nonsensical behavior anymore.
-
-  So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
-  work.
-
-Copyright
----------
-MIT License, see the LICENSE file for more information.
 
-This codebase is a fork of the original lariza browser by Peter Hofmann.
\ No newline at end of file
+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.
+
+  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