X-Git-Url: https://git.armaanb.net/?p=chorizo.git;a=blobdiff_plain;f=README;h=373d692a0d7d09a965c3f75a23f2b5303f044a87;hp=a80087b86782c8131c16043af59422b4be047aa1;hb=HEAD;hpb=011f23568271d6056b9df3f10a00d7da0304e6e3 diff --git a/README b/README index a80087b..373d692 100644 --- a/README +++ b/README @@ -1,31 +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 - - Built-in launching of suckless' tabbed + - 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 - - Optimized hotkeys: Left hand on keyboard, right hand on mouse - - Keyword based searching: Opening "wi foo" will search wikipedia + - Web feeds indicator - Global content zoom - Cooperative instances using FIFOs - Certificate trust store - - Bundled web extensions: - - Adblock + - User script support + - Extensions +Refer to the manpages chorizo(1), chorizo-usage(1), and +chorizo-config(5), for more information. Installation ------------ @@ -34,69 +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 -------- -You simply invoke the main program: - - $ lariza +Background information +---------------------- -Refer to the manpage for all options. +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. -Background information ----------------------- + 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. - What lariza is and what it's not +How is chorizo related to lariza? - 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. :-) + 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. - Especially, it's very likely that lariza will never have a "follow - mode" like dwb, luakit or others have. I've used these browsers for - quite some time and I've also used Firefox extensions that add a - "follow mode". The point is, "follow mode" doesn't work anymore. This - was a good thing ten years ago. Today, a lot of websites make heavy - use of JavaScript or hovering. You NEED some kind of pointing device. - I found using "follow mode" to be very frustrating today, because you - still have to reach for the mouse all the time. So, you might as well - just optimize your mousing workflow. + 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 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. +Migrating from another browser +------------------------------ - lariza tries not to exceed 1000 lines of code. +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.