From 49d63dea6de3dd52810b65a411772dde70607e06 Mon Sep 17 00:00:00 2001 From: Lyn Fugmann Date: Fri, 13 Sep 2024 17:52:31 +0200 Subject: [PATCH] readme: add building section --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b55cfc..b267cf8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,17 @@ This is the WIP rewrite of the ESE website. ## Building -(TODO) +To build the website, install the dependencies and run the build script: +```sh +npm install +npm run build +``` +The output will be in `_site`. + +You can also start a development server with auto-reloading: +```sh +npm run start +``` ## Nix DevShell A nix development shell that provides all required tools for developing and building the project is provided for convenience. Using it is by no means required, although we encourage it.