site/README.md

# Website for *Schulischer Schabernack*

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

This project is licensed under the terms of the MIT License.
You can find its full license text in the file [`LICENSE`](./LICENSE).

This only covers the files in this repository
with the exception of the podcast content (`content/sch???-*`),
which is solely owned by the contributors to the specific episode
with no extra rights granted.
Also, parts of the built website can be covered by other terms,
due to it including code from external projects.
Set chosen brand name Some details still have to be changed (see FIXME comments) 2020-11-24 20:51:24 +01:00			`# Website for Schulischer Schabernack`
Initial commit 2020-08-11 16:14:38 +02:00
Add actually useful content to the readme 2022-01-17 14:43:14 +01:00			`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.
Switch to vserver for hosting This adds nixops deployment and deploys to the vserver in addition to netlify. Currently, the deploy target is not the production target, but instead uses the default hostname of hetzner cloud’s instances. 2020-10-24 21:46:38 +02:00
License the project under the MIT license 2021-12-08 12:00:06 +01:00			`## License`

			`This project is licensed under the terms of the MIT License.`
			You can find its full license text in the file [`LICENSE`](./LICENSE).

			`This only covers the files in this repository`
			with the exception of the podcast content (`content/sch???-*`),
			`which is solely owned by the contributors to the specific episode`
			`with no extra rights granted.`
			`Also, parts of the built website can be covered by other terms,`
			`due to it including code from external projects.`