From 1713c9e01e00b6f4b5814d68e47642a012eb7ae4 Mon Sep 17 00:00:00 2001 From: Ananth Venkatesh Date: Sun, 16 Feb 2025 02:14:38 -0500 Subject: [PATCH] docs(readme): add build instructions --- .pre-commit-config.yaml | 2 +- README.md | 15 +++++++++++++++ flake.nix | 1 - 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8194def..8b50766 120000 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1 +1 @@ -/nix/store/i4wcn83p1273vgv0nggpdbjqppq33aj7-pre-commit-config.json \ No newline at end of file +/nix/store/4wj49hvsmkannf285i53qczyjggvly5w-pre-commit-config.json \ No newline at end of file diff --git a/README.md b/README.md index 7f349ce..8cf032a 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,19 @@ The all-new (very experimental) MacGregor House website +## Building + +To build, run + +`nix build .` + +For live preview, run + +`bash watch.sh` and +`nix run nixpkgs#live-server` + +then navigate to the `src` directory. + +## Models + ![A 3D model of MacGregor House](./assets/img/macg.png) diff --git a/flake.nix b/flake.nix index 67eeeb4..2200896 100644 --- a/flake.nix +++ b/flake.nix @@ -70,7 +70,6 @@ nil.enable = true; statix.enable = true; markdownlint.enable = true; - mdsh.enable = true; typos.enable = true; check-merge-conflicts.enable = true; commitizen.enable = true;