From 81344a495d2539ee7964bbb2de096c168e28a885 Mon Sep 17 00:00:00 2001 From: Simon Bruder Date: Mon, 17 Jan 2022 14:43:14 +0100 Subject: [PATCH] Add actually useful content to the readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6dfac0f..7dc9a37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ # Website for *Schulischer Schabernack* -Prototype for the site of the podcast for the practical seminar podcast. +The website of the podcast for P-Seminar Deutsch „Einen Podcast erstellen“. + +## Building + +Building the site includes encoding all episodes from FLAC to the target formats. +Since this is not easily integrable into the website pipeline, +the build process is quite complicated. +Building the site also requires a special version of FFmpeg +that includes support for the FDK AAC library. +Therefore, it is recommended to use the [Nix package manager](https://nixos.org/) to set up the environment. +Please note that this requires Nix 2.4 or later with the experimental features `nix-command` and `flakes` enabled or Nix 3.0. + +Simply building the site can be accomplished by running `nix build`. +To run the build in-place (not inside the build sandbox), +a development shell can be entered `nix develop` or by using [direnv](https://direnv.net/). +Then, the build script can be run with `./build.sh`. + +The deployment is automated with the script `deploy.sh`. +It automatically builds the site using Nix to achieve reproducibility +and then deploys it via `rsync` to either the staging or production environment. ## License