aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab4b487
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Velstandsfanden website
+
+The site is mainly a [faircamp] site, but with a few external resources. As
+faircamp itself is not meant to build a full website, we tie it all together
+using a Makefile.
+
+Feel free to use as a template for your own setup.
+
+In addition to [faircamp] itself, we use [the simple faircamp aggregator] to
+generate the links to our friends with faircamp sites. We also include a
+directory of additional pages under `sider/`, so some information can be moved
+out from the main faircamp page.
+
+Finally, we use [devd] a simple webserver to serve the site preview.
+
+[faircamp]: https://simonrepp.com/faircamp/
+[the simple faircamp aggregator]: https://codeberg.org/yonder/simple-faircamp-feed-aggregator
+[devd]: https://github.com/cortesi/devd