From 1f1b65bf77c1924f440f625e4dbded59c7ab2bde Mon Sep 17 00:00:00 2001 From: sceox Date: Mon, 1 Aug 2022 11:52:00 -0700 Subject: [PATCH] add config.sample.mk and deployment instructions --- .gitignore | 1 + README.md | 14 ++++++++++++++ config.sample.mk | 10 ++++++++++ 3 files changed, 25 insertions(+) create mode 100644 config.sample.mk diff --git a/.gitignore b/.gitignore index f59e889..27c0727 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ dst tmp +config.mk diff --git a/README.md b/README.md index 4ed35f6..718dfc1 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,20 @@ The rest of the heavy lifting is done by a modified version of [ssg](https://www.romanzolotarev.com/ssg.html) which is included in this source code. ssg requires a POSIX /bin/sh, and awk. +## Deployment + +Configure a webserver to serve static content (HTML, CSS, etc) from a +directory. You will define that directory as `DST` in the next step. + +Clone this repository. Copy config.sample.mk to config.mk and edit it: + + cp config.sample.mk config.mk + micro config.mk + +Run make: + + make + ## TODOs * [ ] TODO discuss and decide on sections diff --git a/config.sample.mk b/config.sample.mk new file mode 100644 index 0000000..c0db4be --- /dev/null +++ b/config.sample.mk @@ -0,0 +1,10 @@ +TITLE = "Anarchy Planet" +BASE_URL = "anarchyplanet.org" +CONTACT_EMAIL = "contact@anarchyplanet.org" + +# static site generator +SSG = ./ssg6 + +# source and destination directories +SRC = src +DST = /var/www/htdocs