aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-01-19 13:19:41 -0500
committerBradley Taunt <bt@btxx.org>2024-01-19 13:19:41 -0500
commit85f2c8d0d69ac0195bf6a20e396077dee0e9aefa (patch)
tree4f3bd878e20e7e057f91da6632a215b004d10c49 /README.md
Initial commit for new cgit platform
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..421494d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# pblog
+
+Pandoc static blog generator
+
+[https://pblog.btxx.org](https://pblog.btxx.org)
+
+## Getting Started
+
+You can always read through the up-to-date article: [Introducing pblog](https://pblog.btxx.org/blog/pblog-intro.html)
+
+But very basic steps:
+
+1. Install dependencies
+2. Write posts in the `posts` directory
+3. Write pages in the `pages` directory
+4. Build the site
+5. Upload your `_output` folder to your web host
+
+Enjoy!