chore(readme): update stow.sh

2023-11-28 11:32:03 +01:00
parent e40bcfef01
commit 2c3272a2d9
2 changed files with 15 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,12 @@
-# my dots
+# my dotfiles
+
+Everything is managed via `stow(1)`.
+
+```bash
+$ ./stow.sh 
+Unknown option, exiting.
+Use ./stow.sh --stow <folder_name> to deploy configuration
+Use ./stow.sh --unstow <folder_name> to remove configuration
+```
+
+`helix(1)` should be built from [source](https://docs.helix-editor.com/install.html), remember to link the `runtime/`.