From 44f7cfcf7085b961608e135b9e23003fecc09218 Mon Sep 17 00:00:00 2001 From: Joshua Goins Date: Sat, 5 Aug 2023 09:32:01 -0400 Subject: [PATCH] Add README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f6f8323..bcae210 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # redstrate.com -This is an experimental rebuild of my [personal website](https://redstrate.com) using sr.ht services instead of my own CI. The content hosted here is going to be temporary until the transition is ready to be completed. +This is the source code of my personal website hosted [redstrate.com](https://redstrate.com/). + +## Building + +You need [Hugo](https://gohugo.io/installation/) (extended edition) to build the site, and optionally Python to run miscellaneous scripts. + +To build the site, just run `hugo` and the built site will appear in `public`. + +``` +$ cd redstrate.com +$ hugo +``` + +For quick development, Hugo has a built-in HTTP server that auto-reloads on changes: + +``` +$ cd redstrate.com +$ hugo server +``` + +### Art + +The art gallery is defined via JSON (in `art`, and other directories in site root) and uses Python to generate the front-matter Markdown files that Hugo consumes. To refresh the gallery, re-run `scripts/gen_art.py`.