Update README.md
This commit is contained in:
parent
f06790f4ab
commit
ecc83e5cc4
26
README.md
26
README.md
|
@ -7,11 +7,19 @@ Backup all your dotfiles (and easily deploy them on another machine).
|
||||||
- [Usage <a name="usage"></a>](#usage-)
|
- [Usage <a name="usage"></a>](#usage-)
|
||||||
- [Dependencies <a name="dependencies"></a>](#dependencies-)
|
- [Dependencies <a name="dependencies"></a>](#dependencies-)
|
||||||
- [Contributing <a name="contributing"></a>](#contributing-)
|
- [Contributing <a name="contributing"></a>](#contributing-)
|
||||||
|
- [Updating <a name="updating"></a>](#updating-)
|
||||||
- [License <a name="license"></a>](#license-)
|
- [License <a name="license"></a>](#license-)
|
||||||
|
|
||||||
## Installation <a name="installation"></a>
|
## Installation <a name="installation"></a>
|
||||||
|
|
||||||
[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 <a name="usage"></a>
|
## Usage <a name="usage"></a>
|
||||||
|
|
||||||
|
@ -47,8 +55,16 @@ You must install `libnewt` or `dialog`.
|
||||||
## Contributing <a name="contributing"></a>
|
## Contributing <a name="contributing"></a>
|
||||||
PRs are welcome.
|
PRs are welcome.
|
||||||
|
|
||||||
## License <a name="license"></a>
|
## Updating <a name="updating"></a>
|
||||||
[MIT](https://choosealicense.com/licenses/mit/)
|
|
||||||
|
|
||||||
[1]: https://github.com/santilococo/sadedot/fork
|
To keep the submodule up to date, you need to run
|
||||||
[2]: https://github.com/santilococo/sadedot/tree/master/dotfiles/other
|
|
||||||
|
```bash
|
||||||
|
sh sadedot/scripts/update.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## License <a name="license"></a>
|
||||||
|
[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
|
||||||
|
|
Loading…
Reference in New Issue