Skip to content

Commit

Permalink
updates readme with instructions on cloning stow version
Browse files Browse the repository at this point in the history
  • Loading branch information
SethGower committed Jul 20, 2021
1 parent 0c25888 commit 6138065
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,26 @@

I use [YADM](https://yadm.io) manage my dotfiles.

Note: If you are looking for when I used [GNU Stow](https://www.gnu.org/software/stow/) checkout [v1.0](https://github.com/SethGower/dotfiles/releases/tag/v1.0)


All you need to do is simply clone this repo (I suggest into `~/.dotfiles`). Because I have some git submodules for `zsh` and `oh-my-zsh`, you need to add the `--recursive` option to the `clone` call. An example of that is below:

```sh
$ yadm clone https://github.com/SethGower/dotfiles.git
$ yadm status
$ yadm submodule init
$ yadm submodule update
```

Or you can use any of the other package folder in this repo.
#### Note on Stow
If you are looking for when I used [GNU Stow](https://www.gnu.org/software/stow/) checkout [v1.0](https://github.com/SethGower/dotfiles/releases/tag/v1.0)

Instructions to clone that are:
```
$ git clone https://github.com/SethGower/dotfiles.git --recursive -b v1.0 $HOME/.dotfiles
$ cd $HOME/.dotfiles
$ stow <package_name>
```
### License

This software is freely distributed under the terms of the [MIT License](https://opensource.org/licenses/MIT)

0 comments on commit 6138065

Please sign in to comment.