README 1.11 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.43)
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)
Sebastian Ramacher's avatar
Sebastian Ramacher committed
19
jscon-c (optional, for configuration dumping support)
Moritz Lipp's avatar
Moritz Lipp committed
20 21 22 23

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

24 25
Run the following command to build and install girara to your system using
meson's ninja backend:
Moritz Lipp's avatar
Moritz Lipp committed
26

Sebastian Ramacher's avatar
Sebastian Ramacher committed
27 28 29 30
  meson build
  cd build
  ninja
  ninja install
31

32 33 34
Note that the default backend for meson might vary based on the platform. Please
refer to the meson documentation for platform specific dependencies.

35 36
Bugs
----
Sebastian Ramacher's avatar
Sebastian Ramacher committed
37

38 39
Please report bugs at http://bugs.pwmt.org or contact us on our mailing list at
girara@lists.pwmt.org.