Update README clone instructions

This commit is contained in:
Salt 2021-01-19 03:30:47 -06:00
parent 916382b5dc
commit 1ed328d882

View File

@ -8,10 +8,9 @@ Clone the repository and stow in configs that you want, like so:
```bash ```bash
cd cd
git clone git@git.desu.ltd:salt/dotfiles .dotfiles git clone git@git.desu.ltd:salt/dotfiles --recurse-submodules .dotfiles
cd .dotfiles cd .dotfiles
git submodule update --recursive --remote stow base # Or whatever config set you want
stow vim # Or whatever config set you want
``` ```
I would highly recommend using this repository only as a reference and building your own dotfile solution from scratch. I would highly recommend using this repository only as a reference and building your own dotfile solution from scratch.
@ -36,5 +35,5 @@ Included within are also a handful of management scripts.
| script | description | | script | description |
| --- | --- | | --- | --- |
| `deploy-all.sh` | Deploys all packages. Note that I reserve the right to produce packages with conflicting contents, so in the future this may be refined to only deploy a specific subset of packages (base, vim, etc.). | | `deploy-all.sh` | Deploys all packages. Note that I reserve the right to produce packages with conflicting contents, so in the future this may be refined to only deploy a specific subset of packages (base, desktop-common, etc.). |
| `submodule-checkout-masters-and-update.sh` | For every submodule in the repo, checks out its master branch (instead of the exact commit specified in the base repo) and then pulls from upstream. Effectively, this updates any submodules in the repo, such as Vim plugins, themes, etc. | | `submodule-checkout-masters-and-update.sh` | For every submodule in the repo, checks out its master branch (instead of the exact commit specified in the base repo) and then pulls from upstream. Effectively, this updates any submodules in the repo, such as Vim plugins, themes, etc. |