sadedot/README.md

32 lines
695 B
Markdown

# CocoRice
Install my dotfiles.
## 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>
Clone the repo.
## Usage <a name="usage"></a>
Run
```bash
./scripts/bootstrap.sh
```
and it will create symbolic links to the dotfiles in this repo.
Note that that this script will overwrite your local dotfiles, so make a backup first.
## Contributing <a name="contributing"></a>
PRs are welcome.
## License <a name="license"></a>
[MIT](https://choosealicense.com/licenses/mit/)