README 1.18 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

14
meson (>= 0.47)
15
glib (>= 2.50)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
16
gtk3 (>= 3.20)
17
intltool
Sebastian Ramacher's avatar
Sebastian Ramacher committed
18
libnotify (optional, for notification support)
19 20 21
json-c (optional, for configuration dumping support)

To disable the optional support for libnotify and json-c, configure the build
22
system with -Dnotify=disabled or -Djson=disabled.
Moritz Lipp's avatar
Moritz Lipp committed
23 24 25 26

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

27 28
Run the following command to build and install girara to your system using
meson's ninja backend:
Moritz Lipp's avatar
Moritz Lipp committed
29

Sebastian Ramacher's avatar
Sebastian Ramacher committed
30 31 32 33
  meson build
  cd build
  ninja
  ninja install
34

35 36 37
Note that the default backend for meson might vary based on the platform. Please
refer to the meson documentation for platform specific dependencies.

38 39
Bugs
----
Sebastian Ramacher's avatar
Sebastian Ramacher committed
40

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