schulischer-schabernack/site
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add actually useful content to the readme

Browse source
This commit is contained in:
Simon Bruder 2022-01-17 14:43:14 +01:00
parent ed6c3ce530
commit 81344a495d
Signed by: simon
GPG key ID: 8D3C82F9F309F8EC
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -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