htmlroc/README.md

28 lines
674 B
Markdown
Raw Normal View History

2019-06-13 22:15:31 +00:00
# htmlroc
2019-06-14 09:37:08 +00:00
Converts MLP:CCG rule files from text to HTML!
2019-06-13 22:15:31 +00:00
## Installation
2019-06-14 09:37:08 +00:00
### Requirements
- Go 1.12+
- The text rules from Hithroc's site:
https://horse.cards/rules/latest.txt
### Running htmlroc
2019-06-13 22:15:31 +00:00
1. Clone project locally and `cd` to it
2019-06-14 09:37:08 +00:00
2. Place the text rules inside the project's folder as `rules.txt`
2019-06-13 22:15:31 +00:00
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
2019-06-14 09:37:08 +00:00
- [CommentaryIsMagic](http://www.commentaryismagic.com/) for maitaining the official rules