From 4929424d2aa9f2309f1e0971deb930ea9cbb7246 Mon Sep 17 00:00:00 2001
From: hippoz <10706925-hippoz@users.noreply.gitlab.com>
Date: Tue, 26 Jul 2022 01:23:27 +0300
Subject: [PATCH] improve README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..887308f
--- /dev/null
+++ b/README.md
@@ -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.