From 7bcfcb8b7fbe1c04e6554a2e828c62484ccb295f Mon Sep 17 00:00:00 2001 From: stefan Date: Wed, 27 Nov 2024 10:03:11 +0000 Subject: [PATCH] Update README.md Fixing instructions --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c10f920..b460550 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,9 @@ Feel free to make a pull request, or join the discussion on [Facebook](https://w ## Building This Site -This site is built with [Eleventy](https://www.11ty.dev) and deployed using [Nix / Nixos](https://nixos.org/), using [Sourcehut's build engine](https://builds.sr.ht), then deployed to [Neocities](https://neocities.org/) using their CLI. +This site is built with [Eleventy](https://www.11ty.dev) and deployed using [Nix / Nixos](https://nixos.org/) -There are three scripts inside `/bin` - `build`, `serve` and `upgrade`. They each use `nix-shell` to fetch the tools they need. - -### ./bin/build [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/build) +### default.nix [(link)](https://git.chobble.com/chobble/vegan-prestwich/src/branch/master/default.nix) - deletes `_site` folder - creates `_site/style` @@ -22,17 +20,15 @@ There are three scripts inside `/bin` - `build`, `serve` and `upgrade`. They eac - minifies and adds vendor prefixes to the CSS using `lightningcss` - builds the site to HTML using Eleventy, into `_site` - minifies the HTML using `html-minifier` -- sets `NEOCITIES_API_KEY` from a Sourcehut secret -- pushes the whole site to Neocities +- copies the output to `$out` -### ./bin/serve [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/serve) +### shell.nix [(link)](https://git.chobble.com/chobble/vegan-prestwich/src/branch/master/shell.nix) -- deletes `_site` folder -- creates `_site/style` -- compiles the SCSS in `style` to CSS in `_site/style` -- builds the site to HTML using Eleventy, into `_site` -- serves it up on http://localhost:8080 - -### ./bin/upgrade [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/upgrade) - -- upgrades the `pnpm-lock.yaml` file to the latest version of Eleventy +- if you call `serve`: + - deletes `_site` folder + - creates `_site/style` + - compiles the SCSS in `style` to CSS in `_site/style` + - builds the site to HTML using Eleventy, into `_site` + - serves it up on http://localhost:8080 +- if you call `upgrade_deps`: + - upgrades the `yarn.lock` file to the latest version of Eleventy