draft 8

[chorizo.git] / README

diff --git a/README b/README
index 7b0509ad5dc0789cd65f8dcffb1087408426162e..a42cedd3563e14239cb34ea0e32b946557440bb7 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,11 @@
-        _                _
-    ___| |__   ___  _ __(_)_______
-   / __| '_ \ / _ \| '__| |_  / _ \
-  | (__| | | | (_) | |  | |/ / (_) |
-   \___|_| |_|\___/|_|  |_/___\___/
-  https://sr.ht/~armaan/chorizo
+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, 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.
+Refer to the manpages chorizo(1), and chorizo-usage(1) for more information.
 
 Installation
 ------------
@@ -34,9 +14,12 @@ 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.
+The following programs are required:
+    - A C compiler supporting C11
+    - make
+    - pkg-config
 
 chorizo expects to be run on a POSIX-ish operating system.
 
@@ -46,31 +29,22 @@ To build and install the program:
     # 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
-  changed from being calendar-based to following the semantic
-  versioning scheme.
-
-
-Copyright
----------
-MIT License, see the LICENSE file for more information.
\ No newline at end of file
+  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