summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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..e7e74d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Simple static blog (generator code and content)
+
+## Install
+
+```
+$ python3 -m venv .env
+$ source .env/bin/activate
+$ pip3 install -r requirements.txt
+```
+
+## Make a post
+
+```
+$ mkdir posts/hello-world
+$ echo 'Title: Hello, World!' > posts/hello-world/metadata.txt
+$ echo 'Date: 2022-12-23' >> posts/hello-world/metadata.txt
+$ echo 'Hello, world!' > posts/hello-world/hello-world.txt
+$ make deploy
+```