Update README.md

This commit is contained in:
Santiago Lo Coco 2021-12-22 12:43:02 -03:00 committed by GitHub
parent e826c59812
commit 43abd30303
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions

View File

@ -1,6 +1,6 @@
# CocoRice # CocoRice
Install my dotfiles. [Fork][1] this repository and you will be able to backup all your dotfiles (and easily install them on another machine).
## Table of contents ## Table of contents
- [Installation <a name="installation"></a>](#installation-) - [Installation <a name="installation"></a>](#installation-)
@ -10,22 +10,22 @@ Install my dotfiles.
## Installation <a name="installation"></a> ## Installation <a name="installation"></a>
Clone the repo. Fork or clone this repo.
## Usage <a name="usage"></a> ## Usage <a name="usage"></a>
Run Run
```bash ```bash
./scripts/bootstrap.sh sudo ./scripts/bootstrap.sh
``` ```
and it will create symbolic links to the dotfiles in this repo. Note that because this script will create symbolic links to the dotfiles in this repository, you must not delete it.
Note that that this script will overwrite your local dotfiles, so make a backup first.
## Contributing <a name="contributing"></a> ## Contributing <a name="contributing"></a>
PRs are welcome. PRs are welcome.
## License <a name="license"></a> ## License <a name="license"></a>
[MIT](https://choosealicense.com/licenses/mit/) [MIT](https://choosealicense.com/licenses/mit/)
[1]: https://github.com/santilococo/CocoRice/fork