X-Git-Url: https://git.armaanb.net/?p=chorizo.git;a=blobdiff_plain;f=README;h=7b0509ad5dc0789cd65f8dcffb1087408426162e;hp=cc0145ed0e69ecdffec7e22c0cd311837ff73e1a;hb=c6937523ec89e9ef5d3008f0b2758ffc9ed16513;hpb=d1f5529a90c0c97c80593acda246c1e609e929b1 diff --git a/README b/README index cc0145e..7b0509a 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ - _ _ - | | __ _ _ __(_)______ _ - | |/ _` | '__| |_ / _` | - | | (_| | | | |/ / (_| | - |_|\__,_|_| |_/___\__,_| - https://sr.ht/~armaan/lariza + _ _ + ___| |__ ___ _ __(_)_______ + / __| '_ \ / _ \| '__| |_ / _ \ + | (__| | | | (_) | | | |/ / (_) | + \___|_| |_|\___/|_| |_/___\___/ + https://sr.ht/~armaan/chorizo - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -11,15 +11,21 @@ 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 + - 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 - - Extension support + - Extensions + +Refer to the manpages chorizo(1), chorizo-usage(1), and +chorizo-config(5), for more information. Installation ------------ @@ -29,58 +35,42 @@ The following C libraries are required: - GTK+ 3 - WebKit2 API for GTK+ 3 -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. + +chorizo expects to be run on a POSIX-ish operating system. -To build the program and install it to /usr/local: +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 +What chorizo is and what it's not - lariza does what I need. It won't do other things. I'm open for + 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. - lariza does not compete with powerful browsers like dwb or luakit, nor - with monstrous applications like Firefox or Chromium. + 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. - About the name +How is chorizo related to lariza? - "lariza" stems from a german sentence: + 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. - 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 +MIT License, see the LICENSE file for more information. \ No newline at end of file