add base of readme
Some checks are pending
ci/woodpecker/push/build Pipeline is pending approval
ci/woodpecker/push/test Pipeline is pending approval

This commit is contained in:
Simon Vieille 2024-07-30 21:44:00 +02:00
commit 7ae22f639b

18
README.md Normal file
View file

@ -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.