From 5168db456f964c14845135233556dafd8049695b Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Sun, 26 May 2024 01:01:55 -0700 Subject: [PATCH] update readme --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7049783..a56b413 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -# gradient ascent +# gradient ascent - yet another developer blog -This repository hosts the source code for my blog, powered by -[hakyll](https://jaspervdj.be/hakyll/). +This repository hosts the source code for my blog, written in Haskell and +powered by [hakyll](https://jaspervdj.be/hakyll/) and +[pandoc](https://pandoc.org). Builds are managed by [nix](https://nixos.org). + +This repo is merely the source code, the actual site is hosted at +[blog.youwen.dev](https://blog.youwen.dev). To build locally, install `nix` and enable flakes. @@ -10,3 +14,23 @@ nix build nix run . watch ``` + +This starts a hot reload server at `localhost:8000`. + +```sh +nix run . build +``` + +This builds a local production version. + +If any updates are made to the JavaScript or CSS, you will need to run + +```sh +pnpm install # only the first time + +pnpm build +``` + +This is because I still haven't figured out how to integrate the `rollup` build +pipeline with `nix`. Since the CSS and JS are minimal, I just do it manually for +now.