]> git.armaanb.net Git - chorizo.git/blob - README
Improve 'location' binding under the hood
[chorizo.git] / README
1    _            _
2   | | __ _ _ __(_)______ _
3   | |/ _` | '__| |_  / _` |
4   | | (_| | |  | |/ / (_| |
5   |_|\__,_|_|  |_/___\__,_|
6   https://sr.ht/~armaan/lariza
7
8 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
9
10 A simple web browser using GTK+ 3, GLib and WebKit2GTK+.
11
12 Features:
13     - A WebKit2 viewport
14     - An input box to change the URI or to search the current page
15     - Built-in download manager
16     - Indicator for web feeds
17     - Full keyboard control
18     - Global content zoom
19     - Cooperative instances using FIFOs
20     - Certificate trust store
21     - User script support
22     - Extension support
23
24 Installation
25 ------------
26
27 The following C libraries are required:
28
29     - GTK+ 3
30     - WebKit2 API for GTK+ 3
31
32 lariza expects to be run on a POSIX-ish operating system.
33
34 To build the program and install it to /usr/local:
35
36     $ make
37     # make install
38
39 To use bundled web extensions, they must be copied or symlinked to the
40 appropriate path. Please refer to the manpage.
41
42
43 Running
44 -------
45
46 You simply invoke the main program:
47
48     $ lariza
49
50 Refer to the manpage for all options.
51
52
53 Background information
54 ----------------------
55
56  What lariza is and what it's not
57
58   lariza does what I need. It won't do other things. I'm open for
59   contributions but please don't be upset if I turn them down -- which
60   might happen if it's a feature that I simply don't need.
61
62   lariza does not compete with powerful browsers like dwb or luakit, nor
63   with monstrous applications like Firefox or Chromium.
64
65  About the name
66
67   "lariza" stems from a german sentence:
68
69       Alle anderen waren mir zu anstrengend.
70        l   a         r    i  z  a
71
72   That phrase basically means: "It was too tiresome to deal with any
73   other browser." I couldn't find a simple browser that does just what I
74   need. Most of them are utterly bloated, others lack essential
75   functions. Thus, I was forced to write scripts and tools and stuff to
76   deal with these issues. That is what was tiresome. I don't want to
77   work around bugs or nonsensical behavior anymore.
78
79   So, I wrote my own browser^W WebKit GUI. WebKit does all the dirty
80   work.
81
82 Copyright
83 ---------
84 MIT License, see the LICENSE file for more information.
85
86 This codebase is a fork of the original lariza browser by Peter Hofmann.