aboutsummaryrefslogtreecommitdiffhomepage
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..138615f
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,14 @@
+# Panblog
+
+> extensible blog generator based on pandoc
+
+Go to the [demo](https://marvinborner.github.io/panblog) or to my [own
+blog](https://text.marvinborner.de).
+
+## Usage
+
+- install `entr`, `pandoc` and its
+ [mermaid-filter](https://github.com/raghur/mermaid-filter)
+- `./new` to create a new entry
+- `./gen` to generate html
+- `./dev` to spin up a development server