aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <franklin@rockbox.org>2019-10-08 14:14:10 -0400
committerFranklin Wei <franklin@rockbox.org>2019-10-08 14:14:10 -0400
commit2e54af8014134af28139d511ed10a27bb31f7d15 (patch)
treeffdbcc8910e50b2a60b1a094df8a42e38fc56f12
parentbf16fee7eb78b9385f6007c14e9e9c4c857dc174 (diff)
downloadblog-2e54af8014134af28139d511ed10a27bb31f7d15.zip
blog-2e54af8014134af28139d511ed10a27bb31f7d15.tar.gz
blog-2e54af8014134af28139d511ed10a27bb31f7d15.tar.bz2
blog-2e54af8014134af28139d511ed10a27bb31f7d15.tar.xz
Add README.md.
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..01c5886
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Blog
+
+This repo contains the source code of my [blog](https://fwei.tk/blog)
+(in Markdown), and a collection of scripts I use to automate building
+and deployment. I created this with solely my own use in mind -- if
+you'd like to use this for your own use, feel free -- but you're on
+your own.
+
+## Overview
+
+Markdown files reside in `posts/`. Each post should have a
+corresponding entry in `index.csv` with `FILENAME.md:TITLE` as the
+fields (note that `:` is the delimiter).
+
+Assorted files (such as images) can be placed in `files/`.
+
+### Building
+
+Install pandoc.
+
+Run `./build.sh` from the project root. This will produce the compiled
+output in `out`.
+
+### Deployment
+
+Run `./deploy.sh`. It will try to log into my website. This will not
+work. Edit it for your own needs.