Add README

This commit is contained in:
Hamcha 2019-06-14 00:15:31 +02:00
parent ac1f316f33
commit 4fd6f2d35b
Signed by: Hamcha
GPG Key ID: A40413D21021EAEE
1 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -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