aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMustafa Salih <37256744+MustafaSalih1993@users.noreply.github.com>2020-12-22 07:40:05 +0300
committerGitHub <noreply@github.com>2020-12-22 07:40:05 +0300
commitf6affec55f1c20366e11accf76b99caf4528753f (patch)
treec55292749bfefcc6ac8643e2933949bf72973f63 /README.md
parent7075f7cf2889076df5f932b17489eee01c6bcccd (diff)
parentd34ef0dd0392674d1a7a8f098b9c57945e96683a (diff)
Merge pull request #3 from MustafaSalih1993/dev
Added rsblocks.yml file and yaml parser to customize
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index d8a6a43..9bdc3c7 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@ A minimal fast dwm status bar written in **Rust** 🦀
* Time/Date
* Used Memory
* Used Disk space
-* Minimal, Fast
+* Easy to configure
+* Minimal
## Note
This tool is still in development stage.
@@ -29,6 +30,20 @@ mv ./target/release/rsblocks /usr/local/bin
you good to go now and can run `rsblocks` from your terminal or put that in your `.xinitrc`
+## Configuration
+**rsblocks** will try to read the file `~/.config/rsblocks/rsblocks.yml`, if it does not exist, it will load the defaults.
+
+create the directory
+```sh
+mkdir ~/.config/rsblocks
+```
+
+copy the [template](./rsblocks.yml) to the new config directory (assuming you are in the root dir of the repo)
+```sh
+cp ./rsblocks.yml ~/.config/rsblocks/rsblocks.yml
+```
+
+
## Contributions
All Contributions are welcome.