aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..18b55ef7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+This blog can be built with the `pyblog` script. The `pyblog` script currently provides the following actions:
+
+* `new_post` (aliases: `n`, `new`);
+* `touch` (aliases: `t`, `tou`);
+* `generate` (aliases: `g`, `gen`);
+* `regenerate` (aliases: `r`, `regen`);
+* `preview` (aliases: `p`, `pre`).
+* `deploy` (aliases: `d`, `dep`);
+* `gen_deploy` (aliases: `gd`, `gendep`);
+
+Run `pyblog --help` for more information, and `pyblog <action> --help` for what the action does and how to perform the action.
+
+Note that `pyblog` is incompatible with Python 2.x, and in fact only tested on Python 3.4.
+
+The theme of this blog is largely based on that of [mort.ninja](http://mort.ninja) by [Mort Yao](https://github.com/soimort). See [this post](https://zmwangx.github.io/blog/2015-05-05-new-blog-new-start.html) for more details.