From cc7f926eeb17f28fc03c87e828b7bbbd35715c31 Mon Sep 17 00:00:00 2001 From: Dominik George <dominik.george@teckids.org> Date: Sat, 9 Mar 2024 14:25:58 +0100 Subject: [PATCH] Add readme --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..5d4b09a3 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Teckids website + +## How to build + +### Install yarn and Zola + +#### On Debian + +``` +sudo apt install cargo yarnpkg +cargo install zola +``` + +#### On openSUSE Tumbleweed + +```shell +sudo zypper install yarn zola +``` + +### Install JavaScript dependencies + +```shell +yarn install +``` + +### Build HTML output + +```shell +zola build +``` + +Alternatively, run local development server: + +```shell +zola serve +``` -- GitLab