summaryrefslogtreecommitdiffstats
path: root/etc/README.md
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@atos.net>2019-04-24 13:19:46 +0200
committerMatthias Beyer <matthias.beyer@atos.net>2019-04-24 13:19:46 +0200
commit41c5a9c5a601733809f15b98a3ba79db8f896518 (patch)
tree8abb20326af0184e08c1fef6aeb566c66b53d31d /etc/README.md
parentea40d481ad8c68baab770af48d36014facb9cfbb (diff)
Add html templates for generating nice report websites
Diffstat (limited to 'etc/README.md')
-rw-r--r--etc/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/etc/README.md b/etc/README.md
new file mode 100644
index 0000000..c93152b
--- /dev/null
+++ b/etc/README.md
@@ -0,0 +1,13 @@
+# HTML templates
+
+This directory contains HTML templates which can be used with the "json" output
+format and a tool that can fill templates with data.
+For example, this can be used with [hdlbr](https://github.com/quitoque/hdlbr)
+to generate nice websites for the reported data.
+
+## Usage with hdlbr
+
+```bash
+repolocli -o json ... > data.json
+hdlbr data.json template.html > output.html
+```