Rename web_extensions to web-extensions

[chorizo.git] / README

diff --git a/README b/README
index f7b3eda8b0821a2c6725bc214fe70cf8890073c9..373d692a0d7d09a965c3f75a23f2b5303f044a87 100644 (file)
--- a/README
+++ b/README
@@ -34,6 +34,7 @@ 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.
@@ -67,9 +68,40 @@ How is chorizo related to lariza?
   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.
+  moved away from being calendar-based.
 
+  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
+
+Migrating from another browser
+------------------------------
+
+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.
+
+  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.
+
+From Firefox/Chromium/Brave/etc:
+  1. Set your expectations right. Read the background information
+  section of the README.
+
+  2. Copy the cookie database into ~/.local/share/lariza/cookies.db.
+
+  3. Read all the manpages.
 
 Copyright
 ---------