aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2024-12-27 11:37:08 -0800
committerFranck Cuny <franck@fcuny.net>2024-12-27 11:37:29 -0800
commitb4bb5cbc3b8a5866aa3c743354c7ecb640156f26 (patch)
treef8b852851f9fe63444b6444aca26cf3472fd100b
parentMerge pull request #4 from fcuny/dependabot/github_actions/DeterminateSystems... (diff)
downloadfcuny.net-b4bb5cbc3b8a5866aa3c743354c7ecb640156f26.tar.gz
refresh the README
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index e2874e9..96899cd 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,19 @@
## Run
-The dependencies are managed with nix. Running `nix run` will start the hugo server.
+Running `just run` will start the `zola` server.
+## Build
+
+Running `just build` will build the site, and the content will be available under `result/`.
## Deploy
-You can deploy the site by running `nir run .#deploy`.
+The site is deployed by a [GHA](.github/workflows/page.yml).
+
+## Maintenance
+
+Running `just validate` will run some validations (checking the links for example).
+
+A few GHA are taking care of checking the validity of the flake, and will report if the [flake.lock](flake.lock) is out of date.
+
+Another GHA will run periodically to bump the [flake.lock](flake.lock).