diff --git a/README.md b/README.md new file mode 100644 index 0000000..59150e0 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# htmlroc + +Converts MLP:CCG rule files from text (thanks Hithroc!) to HTML! + +## Installation + +1. Clone project locally and `cd` to it +2. Download `rules.txt` from Hithroc's site and place it inside the project's folder: + https://horse.cards/rules/latest.txt +3. Run this command: + ``` + go run . + ``` + +Alternately, you can compile with `go install` and use the command line flags to specify location of `rules.txt` and `template.html` + +## Thanks to + +- [Hithroc](https://hithroc.org/) for maitaining text versions of the rules +- [CommentaryIsMagic](http://www.commentaryismagic.com/) for maitaining the rules