aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormustafa salih <mustafasalih1991@gmail.com>2020-12-21 14:11:19 +0300
committermustafa salih <mustafasalih1991@gmail.com>2020-12-21 14:11:19 +0300
commit92e699bc4604c5b72bdad53aeff99884bec45aa0 (patch)
treefe968576b31f1681880f9e54f9059ddac8416d18 /README.md
parente26d3ff2cdb3b8cdc8abc26c4924f6542782f551 (diff)
edited README
Diffstat (limited to 'README.md')
-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.