]> git.armaanb.net Git - chorizo.git/blobdiff - README
Rename web_extensions to web-extensions
[chorizo.git] / README
diff --git a/README b/README
index 6192a0c49dff598aa4932b21ca7a5e78ccb2dee2..373d692a0d7d09a965c3f75a23f2b5303f044a87 100644 (file)
--- a/README
+++ b/README
@@ -1,32 +1,31 @@
-   _            _
-  | | __ _ _ __(_)______ _
-  | |/ _` | '__| |_  / _` |
-  | | (_| | |  | |/ / (_| |
-  |_|\__,_|_|  |_/___\__,_|
-  https://uninformativ.de/git/lariza
-  https://uninformativ.de/bugs.html
-
+        _                _
+    ___| |__   ___  _ __(_)_______
+   / __| '_ \ / _ \| '__| |_  / _ \
+  | (__| | | | (_) | |  | |/ / (_) |
+   \___|_| |_|\___/|_|  |_/___\___/
+  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 or to search the current page
+    - 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
-    - Indicator for web feeds
-    - Optimized hotkeys: Left hand on keyboard, right hand on mouse
+    - Web feeds indicator
     - Global content zoom
     - Cooperative instances using FIFOs
     - Certificate trust store
-    - Bundled user-supplied JavaScripts (optional):
-        - Link hints
-    - Bundled web extensions (optional):
-        - Adblock
+    - User script support
+    - Extensions
 
+Refer to the manpages chorizo(1), chorizo-usage(1), and
+chorizo-config(5), for more information.
 
 Installation
 ------------
@@ -35,57 +34,75 @@ 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.
+To generate the manpages, scdoc is required. This isn't necesary on
+release tarballs.
 
-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
--------
+Background information
+----------------------
 
-You simply invoke the main program:
+What chorizo is and what it's not
 
-    $ lariza
+  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.
 
-Refer to the manpage for all options.
+  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?
 
-Background information
-----------------------
+  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.
 
- What lariza is and what it's not
+  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
 
-  lariza does what I need. It won't do other things. I'm open for pull
-  requests 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. That being said,
-  you should have a look at the PATCHES file. :-)
+Migrating from another browser
+------------------------------
 
-  lariza does not compete with powerful browsers like dwb or luakit, nor
-  with monstrous applications like Firefox or Chromium. lariza won't
-  have persistent storage, nor a plugin system, nor cloud sync, nor
-  bookmarks.
+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.
 
- About the name
+  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.
 
-  "lariza" stems from a german sentence:
+From Firefox/Chromium/Brave/etc:
+  1. Set your expectations right. Read the background information
+  section of the README.
 
-      Alle anderen waren mir zu anstrengend.
-       l   a         r    i  z  a
+  2. Copy the cookie database into ~/.local/share/lariza/cookies.db.
 
-  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.
+  3. Read all the manpages.
 
-  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.