slococo
/
sadedot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Create README.md

This commit is contained in:
Santiago Lo Coco 2021-12-21 18:40:08 -03:00 committed by GitHub
parent b3ec50c43f
commit 120196bc00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# 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/linkFiles.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/)