From d68349edb6ad77bb4dd50cba08e5c5e1e046d512 Mon Sep 17 00:00:00 2001 From: jolheiser Date: Fri, 29 Sep 2023 10:17:57 -0500 Subject: [PATCH] docs: update readme Signed-off-by: jolheiser --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d264070..ce91590 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,26 @@ My [personal website](https://jolheiser.com). -Uses [tailwind](https://tailwindcss.com/) (with [catppuccin btw](https://github.com/catppuccin/tailwindcss)) and [11ty](https://www.11ty.dev/) as a simple static page generator. +Uses [tailwind](https://tailwindcss.com/) (with [catppuccin btw](https://github.com/catppuccin/tailwindcss)) and [templ](https://github.com/a-h/templ) as a simple static page generator. -Eleventy is potentially even too much, but it made generating the SVGs and looping links easier. - -Links are sourced from [package.json](package.json). +Links are sourced from [links.yaml](links.yaml). ## Dev -```bash -yarn install # Install deps -yarn dev # Serve locally and watch for changes -yarn build # Build dist +### Tools + +``` +nix develop +``` + +If nix isn't available: +- [Go](https://go.dev) +- [templ](https://github.com/a-h/templ) +- [tailwind-ctp](https://git.jojodev.com/jolheiser/tailwind-ctp) (TailwindCSS standalone CLI with Catppuccin support) + + +### Building + +```bash +go generate ```