aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index b80df33..4059f0f 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,22 @@ A minimal fast dwm status bar written in **Rust** 🦀
## Note
This tool is still in development stage.
+## Install
+clone the repo
+```sh
+git clone https://github.com/mustafasalih1993/rsblocks
+```
+build with **cargo**
+```sh
+cargo build --release
+```
+move the executable somewhere in your **PATH** (assuming you are in the root dir of the project)
+```sh
+mv ./target/release/rs_blocks /usr/local/bin
+```
+
+you good to go now and can run `rs_blocks` from your terminal or put that in your `.xinitrc`
+
## Contributions
All Contributions are welcome.