diff --git a/README.md b/README.md index 099ce2e..7861033 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Fediverse Fanzine ## Using the template engine -For template engine (bash-tpl)[https://github.com/TekWizely/bash-tpl] is used. Bash-tpl template engine allows for bash injections into templates. I hope that most of options required are displayed in the example, since I have no idea what kind of design is coveted for fedizine. +For template engine [bash-tpl](https://github.com/TekWizely/bash-tpl) is used. Bash-tpl template engine allows for bash injections into templates. I hope that most of options required are displayed in the example, since I have no idea what kind of design is coveted for fedizine. Templating is split into 3 stages. 0. Template and files preparation @@ -12,7 +12,7 @@ Templating is split into 3 stages. 2. Template population ### Template and files preparation -As an example a file (fedizine_template_example.html)[fedizine_template_example.html] is provided. For now there's nothing fancy, it is just a modified index.html page. +As an example a file [fedizine_template_example.html](fedizine_template_example.html) is provided. For now there's nothing fancy, it is just a modified index.html page. The template expects a folder named "contestants" in the same directory as itself. Contestants folder would hold a bunch of other directories, one per contestant. Names of those folders are not used in templating, but imagine you'd want something readable.