summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkotontrion <[email protected]>2024-05-23 16:20:38 +0200
committerGitHub <[email protected]>2024-05-23 16:20:38 +0200
commit2a148886dcf186afaf8393cccdc39ce4c7ebcbc7 (patch)
tree590e55d8124fe4a794422cb9d4f09162f5aa74e0
parentf54981f20f6418848fa86fbd6d56642906ef0f17 (diff)
Create README.md
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c436746
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# libastal-tray
+a library for managing the systemtray by implementing the StatusNotifierItem dbus protocol.
+
+## Build from source
+### Dependencies
+
+- meson
+- glib
+- gdk-pixbuf
+- gtk3
+- gobject-introspection
+- dbusemenu-gtk3
+- vala
+
+```sh
+# Clone the repository
+git clone https://github.com/astal-sh/tray
+cd tray
+
+# Setup and build
+meson setup build
+meson compile -C build
+
+# Install
+meson install -C build
+```
+
+## Todo
+- docs
+- cli tool