diff options
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c85313 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# My Personal Dotfiles + +I keep a curated list of my dotfiles in this repository. To use them, you will need [GNU Stow](https://www.gnu.org/software/stow/). + +Each folder is a _package_ that can be installed individually. I try to keep things that go together in a single package. To install a package, assuming that you have cloned this repository in your home folder, you have to run +```bash +stow --dotfiles [-v] [pkg-name] +``` +(the `-v` flag is for being verbose, which is a good thing if you're using stow). + +For convenience, the script [setup-all.bash](./setup-all.bash) stows everything. + +Each package might have its own README, which I list below for easier reference: +- [bash](./bash/README.md) |