From 87925dacbf3b3a6f7ce8657df8c6e3b9d576f6ab Mon Sep 17 00:00:00 2001 From: teutat3s Date: Mon, 3 Jul 2023 00:36:48 +0200 Subject: [PATCH] Improve quickstart development docs --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 84abab5..f5c71e6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,36 @@ -Install Lume: +# miom.space homepage -https://lume.land/docs/overview/installation/ +This is the repository containing the code for https://miom.space. + +It is built using [lume](https://lume.land/) with JSX. To get started, make sure +you have the [nix package manager](https://nixos.org/download.html) installed. +Then you can start developing with: ``` -deno run -Ar https://deno.land/x/lume/init.ts +nix develop ``` -Build the project: +This will use a [nix devshell](https://nix.dev/tutorials/first-steps/ad-hoc-shell-environments#ad-hoc-envs) +to create an environment that has [deno](https://deno.land/) and [lume](https://lume.land/) +available. + +An alternative approach for loading all dependencies is [`direnv`](https://direnv.net). +It basically runs `nix develop` for you, once you enter a directory which +contains a `.envrc` file and allow it by running `direnv allow`. Once installed +globally, run: + +``` +direnv allow +``` + +Just build the static site, results are in `_site`: + ``` ./build.sh ``` -Run a local version of the project: +To get a live development server, run: + ``` deno task serve ```