README 1.43 KB
Newer Older
Moritz Lipp's avatar
Moritz Lipp committed
1 2
girara - user interface library
===============================
Sebastian Ramacher's avatar
Sebastian Ramacher committed
3

Moritz Lipp's avatar
Moritz Lipp committed
4 5 6 7 8
girara is a library that implements a user interface that focuses on simplicity
and minimalism. It consists of three main components: The view is a widget that
represents the actual application (e.g.: a web site or a document). The input
bar is used to execute commands of the application, while the status bar
notifies the user with current information. It is designed to replace and the
9
enhance the user interface that is used by zathura.
Moritz Lipp's avatar
Moritz Lipp committed
10 11 12

Requirements
------------
Sebastian Ramacher's avatar
Sebastian Ramacher committed
13

Sebastian Ramacher's avatar
Sebastian Ramacher committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
The following dependencies are required:

* gtk3 (>= 3.20)
* glib (>= 2.50)

The following dependencies are optional:

* libnotify: notification support
* json-c: configuration dumping support

For building girara, the following dependencies are also required:

* meson (>= 0.48)
* gettext

The following dependencies are optional build-time only dependencies:

* check: for tests
* doxygen: HTML documentation
33 34

To disable the optional support for libnotify and json-c, configure the build
35
system with -Dnotify=disabled or -Djson=disabled.
Moritz Lipp's avatar
Moritz Lipp committed
36 37 38 39

Installation
------------

40 41
Run the following command to build and install girara to your system using
meson's ninja backend:
Moritz Lipp's avatar
Moritz Lipp committed
42

Sebastian Ramacher's avatar
Sebastian Ramacher committed
43 44 45 46
  meson build
  cd build
  ninja
  ninja install
47

48 49 50
Note that the default backend for meson might vary based on the platform. Please
refer to the meson documentation for platform specific dependencies.

51 52
Bugs
----
Sebastian Ramacher's avatar
Sebastian Ramacher committed
53

Sebastian Ramacher's avatar
Sebastian Ramacher committed
54
Please report bugs at https://git.pwmt.org/pwmt/girara.