diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..d4d9297 --- /dev/null +++ b/README.adoc @@ -0,0 +1,33 @@ += euandre.org + +The source of https://euandre.org: a personal website of articles, +notes, pastebins, podcasts, screencasts and slide decks, in six +languages, built by *mkwb*(1) from asciidoc. + +The site is static in the strict sense --- every page, feed and +sitemap is a file on disk, and serving it needs nothing but a web +server. Translations are generated by *po4a*(1) from one catalogue +per language, so a change to the English source propagates rather +than drifting. Slide decks render to PDF through *eslaides*(1), +and the music pages are engraved from LilyPond sources. + +== Build + +.... +make # the whole site under src/content/ +make check # seventeen consistency checks +make install # into $(DESTDIR)$(HTMLDIR) and $(DESTDIR)$(SRCDIR) +make i18n # regenerate translations from po/ +make run # serve the installed tree +.... + +The rules come from *mkwb*: `mkdeps.sh` ends with `mkwb rules`, +which inlines them into `deps.mk`. What is here is only what is +this site's --- its name, its languages, its port. + +Compression is not the build's business: `make install` ships +content, and *gzipdir*(1) walks the installed tree afterwards. + +== Licence + +The content is CC BY-SA 4.0. The code is AGPL-3.0-or-later. |