From 16e730f540acfe6a0015464c81831cdfacaf107b Mon Sep 17 00:00:00 2001
From: Alexey Yerin <yyp@disroot.org>
Date: Sun, 28 May 2023 14:10:05 +0300
Subject: Initial commit

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..559c6cf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# hare-gi
+GObject Introspection code generator for Hare. In short, it creates bindings for
+GTK family of libraries (GTK+, GDK, Pango, etc).
+
+## Generating and installing bindings
+Dependencies:
+* An up-to-date [Hare] toolchain
+* [hare-fastxml]
+* Development files for the desired GTK version and its dependencies. Make sure
+`/usr/share/gir-1.0` is included.
+
+A few core libraries do not ship GIR XML files by default. They can be obtained
+from gobject-introspection:
+
+```
+git clone https://gitlab.gnome.org/GNOME/gobject-introspection.git
+meson setup build/
+ninja -C build/
+
+# The path where this is downloaded will be used later
+```
+
+### GTK 3
+```
+./generate <path to gobject-introspection>
+make install
+```
+
+### GTK 4
+```
+./generate4 <path to gobject-introspection>
+make install4
+```
+
+## Running examples
+### GTK 3
+```
+make demo
+./demo
+```
+
+### GTK 4
+```
+make demo4
+./demo4
+```
+
+## Contributing
+Please send patches to [~yerinalexey/public-inbox@lists.sr.ht][archives] using
+[git send-email] with prefix set to `hare-gi`:
+
+```shell-session
+$ git config format.subjectPrefix "PATCH hare-gi"
+```
+
+[Hare]: https://harelang.org/installation
+[hare-fastxml]: https://git.sr.ht/~yerinalexey/hare-fastxml
+[archives]: https://lists.sr.ht/~yerinalexey/public-inbox
+[git send-email]: https://git-send-email.io
-- 
cgit 1.3.0-6-gf8a5