From 9a4b698d68996f5a40c3f55ad5ba1fa90972b17b Mon Sep 17 00:00:00 2001 From: Robert Pearce Date: Wed, 22 Feb 2023 13:53:13 +1300 Subject: [PATCH] chore(docs): add quick tips to readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e72c8e7..ae1768b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ [Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org) template +## Quick tips + +* Read the tutorial to get started! https://robertwpearce.com/the-hakyll-nix-template-tutorial.html +* If you make changes to anything inside of `ssg/`, you'll need to clean the + hakyll cache and rebuild. This is the preferred series of commands for + rebuilding (with logs), cleaning the cache, and re-running the dev server: + + ```default + nix build --print-build-logs && \ + nix run . clean && \ + nix run . watch + ``` + ## Features * Build your site into the `./result/dist` folder: