From ecc83e5cc43a2169877f93797f7b8f210afde105 Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Wed, 19 Jan 2022 15:49:55 -0300 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b5528e5..9995cbe 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,19 @@ Backup all your dotfiles (and easily deploy them on another machine). - [Usage ](#usage-) - [Dependencies ](#dependencies-) - [Contributing ](#contributing-) + - [Updating ](#updating-) - [License ](#license-) ## Installation -[Fork][1] this repository. +This repo is supposed to be used as a submodule. So, if you already have a git repo with your dotfiles: + +```bash +git submodule add git@github.com:santilococo/sadedot.git +git submodule update --init +``` + +And if you don't, you can [fork][1] my dotfiles repo on github. ## Usage @@ -47,8 +55,16 @@ You must install `libnewt` or `dialog`. ## Contributing PRs are welcome. -## License -[MIT](https://choosealicense.com/licenses/mit/) +## Updating -[1]: https://github.com/santilococo/sadedot/fork -[2]: https://github.com/santilococo/sadedot/tree/master/dotfiles/other +To keep the submodule up to date, you need to run + +```bash +sh sadedot/scripts/update.sh +``` + +## License +[MIT](https://raw.githubusercontent.com/santilococo/sadedot/master/LICENSE.md) + +[1]: https://github.com/santilococo/dotfiles/fork +[2]: https://github.com/santilococo/dotfiles/tree/master/dotfiles/other