From 9b5e8266169a7c8c137162e16c6ec25958294916 Mon Sep 17 00:00:00 2001 From: arne Date: Sun, 20 Feb 2022 18:21:09 +0100 Subject: [PATCH] Add README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..070a249 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# arnes.space + +This repository contains the source files for https://arnes.space. It uses [eleventy](https://www.11ty.dev/docs/) and [pnpm](https://pnpm.io/) to build a static website from a bunch of files that you can find in the `src/` folder. + +## Available Commands + +``` sh +# build the complete site +pnpm build + +# run a local server that automatically changes as you update content +pnpm start # is the same as `pnpm watch` +``` + +## Build Environment + +The build environment is described in `flake.{nix,lock}` and `.envrc`. You can use [direnv](https://direnv.net/) and [nix with flakes support](https://nixos.org/) to automatically drop into a shell that contains all tools for building the website.