aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkdamani <kdamani@kdamani-art.hitronhub.home>2020-10-21 21:22:16 +0000
committerkdamani <kdamani@kdamani-art.hitronhub.home>2020-10-21 21:22:16 +0000
commit8679380bd39b26336e89c84da0bd0693b2da8bf8 (patch)
tree9d8c89f8bb18e374434e9f5d23a0d41c90b05e5b
parent997d9f8ff9ba47aed509c77baa3183a67eaf9596 (diff)
updated readme
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index ddf5e83..0f212c5 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,14 @@
These are my *personal* dotfiles and they work for me. I know they are not optimal and there are ways to implement a lot of the functionality better ... I just haven't gotten around to it.
-If you like a module or two (polybar, mutt, vifm etc), you can install the configs by running:
+Chances are once you install them, you will need to modify a few things to get it working perfectly, this is normal and probably will give you a chance to customize things per your liking.
+
+## Installation
+If you like a module or two (polybar, bspwm, ranger etc), you can install the configs by running:
`stow -v -t <TARGET_DIR> <MODULE_NAME(S)>` from the dotfiles directory.
-eg, If you want polybar and vifm only:
-`stow -v -t ~ polybar vifm`
-This will install polybar and vifm in `/home/<user>/.config/polybar|vifm`.
+eg, If you want polybar and ranger only:
+`stow -v -t ~ polybar ranger`
+This will install polybar and ranger in `/home/<user>/.config/polybar|ranger`.
+
+> Many of the modules depend on helper scripts. These are all (for now) under the Scripts modules. You can install it the same as other modules. Once installed make sure that it is in your PATH. See the `profile_min/.profile` file for an example. You can also do this in another way (bashrc etc.)