From 7ae22f639bf7fd9350ba5a7c2b93ac2947f6fe95 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Tue, 30 Jul 2024 21:44:00 +0200
Subject: [PATCH] add base of readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d80f281
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# 🖥️ i3 wallpaper manager
+
+**i3 wallpaper manager** is a command-line tool designed to change the wallpaper depending of active workspaces on [i3](https://i3wm.org/).
+
+## 📗 How to install the project
+
+Pre-compiled versions are available in the [Releases](https://gitnet.fr/deblan/i3-wallpaper-manager/releases). For Debian users, a package is also provided.
+
+If you want to compile the project from source, you will need at least the GO compiler version 1.22. Clone the project and run the make command. The compiled output will be located in the `build` directory.
+
+```
+$ git clone https://gitnet.fr/deblan/i3-wallpaper-manager
+$ make
+```
+
+## 🧪 How to use the project
+
+TODO.