From 79fd9e8be8618d69ebb9e50d82aa0eccac05a4e7 Mon Sep 17 00:00:00 2001
From: pacien
Date: Sun, 4 Sep 2022 14:28:52 +0200
Subject: flake: add useful commands to readme

---
 flake.nix |  5 +----
 readme.md | 29 +++++++++++++++++++++++++----
 2 files changed, 26 insertions(+), 8 deletions(-)

diff --git a/flake.nix b/flake.nix
index 8ad216c..36c1b4a 100644
--- a/flake.nix
+++ b/flake.nix
@@ -17,10 +17,7 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 {
-  description = ''
-    A static generator which turns a collection of tagged pictures into a \
-    searchable web gallery.
-  '';
+  description = "A static web gallery generator with tags";
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
diff --git a/readme.md b/readme.md
index 1fede70..6cd7396 100644
--- a/readme.md
+++ b/readme.md
@@ -1,13 +1,34 @@
 ldgallery
 =========
 
-A static gallery generator which turns a collection of tagged pictures and media into a searchable web gallery.
+A static gallery generator which turns a collection of tagged pictures and
+media into a searchable web gallery.
 
-The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org.
+The complete list of features, the user manual, demo and download links can be
+found on the project's website: <https://ldgallery.pacien.org>.
 
 
-Build
------
+Usage and build (using the Nix Flake)
+-------------------------------------
+
+This program is available as a Nix Flake allowing to build both the viewer
+and compiler components and assemble those automatically.
+
+The following commands are available on NixOS, or a Linux or MacOS system
+having the Nix package manager installed:
+
+* Just running the program (compiler with bundled viewer):
+  * Using the latest release: `nix run github:ldgallery/ldgallery -- --help`
+  * Using a local source checkout: `nix run .# -- --help`
+
+* Building individual components locally:
+  `nix build .#{compiler,viewer,man} --print-build-logs`
+
+
+Manual build
+------------
+
+Without using the Nix Flake, the project can be built as follows:
 
 * Compile the web _viewer_ as detailed in `./viewer/readme.md`.
 * Copy/link the compiled _viewer_ to the _ldgallery compiler_ data directory.
-- 
cgit v1.2.3