improve README

This commit is contained in:
hippoz 2022-07-26 01:23:27 +03:00
parent 112a3b83d3
commit 4929424d2a
No known key found for this signature in database
GPG key ID: 7C52899193467641

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# Raven
Raven is a simple user interface library.
# Dependencies
- meson *(make)*
- ninja *(make)* *(for meson)*
- cairo
- cairomm
- pango
- pangocairo
- xlib
# Installing
If you wish install libraven on your GNU/Linux system, run the script in `pkg/install.sh`. Before running the script, please read its contents to make sure its actions are compatible with your system setup.
If you use Arch Linux or a derivative, you can use the package inside of `pkg/makepkg`:
```
$ cd pkg/makepkg
$ makepkg -si
```
Please note that the Arch Linux package will build Raven from the remote git repository, not your local source tree.
# Hacking
If you wish to develop Raven or look at the test program, set up a Meson build directory and compile Raven:
```
$ meson builddir
$ cd builddir
$ meson compile
```
You should see `ravenapp` (the test program) and `libraven.so` (the Raven library) in the build directory.