From db94c8e22556887afa129650a4d16a82f0f94599 Mon Sep 17 00:00:00 2001 From: kayomn Date: Fri, 18 Aug 2023 01:31:31 +0200 Subject: [PATCH] Add readme --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ea5258a --- /dev/null +++ b/readme.md @@ -0,0 +1,17 @@ +# Pizza Wednesday Site + +This repo contains the scripts, templates, and blog posts necessary to build the Pizza Wednesday landing site from scratch. + +While only intended to be used by contributors for publishing new articles and changes to the website, the source files are publicly viewable for transparency and posterity. + +## Publishing + +Being a python script that is doing somewhat non-trivial stuff, `publish.py` will require some non-standard dependencies to run properly. + + * `markdown` for parsing the markdown source files into HTML. + * `strip_markdown` for converting markdown source file content into plain text. + * `jinja2` for template generation of the site contents. Without tools like it, creating static websites is a fairly miserable experience + +And of course a Python interpreter will be required - specifically any compatible with CPython libraries like the ones listed above. + +Once these dependencies are satisifed, generating the website should be as simple as running `publish.py`. If it does fail to run at this point, please file a bug report. \ No newline at end of file