README.md

myRetro Generator

This is a static site generator that parses a plain markdown file and fills out a HTML version that you then can either display with github pages or you can convert it to pdf.

Set this up for yourself

Refer to the template repository for instructions

Run this by yourself

Download the prebuilt binaries from the releases tab (seriously it takes half an hour for a clean build, you don't want to build it yourself). Then unzip it and place a myRetro markdown next to it (see Example.md for a template).

To run the generator type:

./myRetroGenerator myRetro.md

You can see all the options with ./myRetroGenerator --help