diff options
| author | Toby Vincent <tobyv13@gmail.com> | 2022-09-30 11:01:28 -0500 |
|---|---|---|
| committer | Toby Vincent <tobyv13@gmail.com> | 2022-09-30 11:01:28 -0500 |
| commit | 121e6f37fd643b6d4bb8efbb2dcb1999559a3e9c (patch) | |
| tree | 4c2228d385929996709768691de0576c77394cad /README.md | |
| parent | 2a592b13070ea7e57f0f6d839edd205ed9fed3e2 (diff) | |
docs: update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 12 insertions, 12 deletions
@@ -1,19 +1,19 @@ -tobyvin's dotfiles -================== +# tobyvin's [.dotfiles] -Install -------- +## Install ```sh -git clone https://git.sr.ht/~tobyvin/.dotfiles ~/.dotfiles && cd ~/.dotfiles && make stow +git clone https://git.sr.ht/~tobyvin/.dotfiles ~/.dotfiles && cd ~/.dotfiles && ./install.sh ``` -Getting started ---------------- +## Getting started -The configuration files are managed using gnu stow and make. The Makefile -includes targets for stowing, un-stowing, and cleaning the symlinks. It also -has targets for installing a selection of tools I use. +The configuration files are managed using GNU [stow]. The included [install.sh] +script can be used to stow specified (or, if unspecified, all) packages using +`./install.sh [package ..]`, clean broken symlinks from `$HOME` using +`./install.sh -C`, or both with `./install.sh -c [package ..]`. Run +`./install.sh -h` to see all options. -Run `make interactive` or simply `make` to view and interactively select targets -to install. +[.dotfiles]: https://sr.ht/~tobyvin/.dotfiles/ +[stow]: https://www.gnu.org/software/stow/ +[install.sh]: ./install.sh |