diff --git a/README.md b/README.md new file mode 100644 index 0000000..6afefa6 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# CocoRice + +Install my dotfiles. + +## Table of contents +- [Installation ](#installation-) +- [Usage ](#usage-) +- [Contributing ](#contributing-) +- [License ](#license-) + +## Installation + +Clone the repo. + +## Usage + +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 +PRs are welcome. + +## License +[MIT](https://choosealicense.com/licenses/mit/)