sadedot/README.md

32 lines
825 B
Markdown

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