From caedd088049af5e1ee059a6e35fc8db724246219 Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Sun, 29 Dec 2024 14:15:30 -0800 Subject: [PATCH] docs: add hacking instructions to readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 41487be..03194f2 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,21 @@ The markdown files in this repository are Obsidian flavored and are automatically compiled into the knowledge garden at [garden.youwen.dev](https://garden.youwen.dev). Please visit! +### Hacking + +Builds are powered by Nix. Run + +```sh +nix build +``` + +to produce a static bundle at `result/public`. A local development server can +be started at `localhost:8080` by running + +```sh +nix run +``` + ## Typst compilation infrastructure This repository contains a sophisticated system for reproducibly compiling