aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md29
1 files changed, 25 insertions, 4 deletions
diff --git a/readme.md b/readme.md
index 955ebe6..b363490 100644
--- a/readme.md
+++ b/readme.md
@@ -1,13 +1,34 @@
1ldgallery 1ldgallery
2========= 2=========
3 3
4A static gallery generator which turns a collection of tagged pictures and media into a searchable web gallery. 4A static gallery generator which turns a collection of tagged pictures and
5media into a searchable web gallery.
5 6
6The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org. 7The complete list of features, the user manual, demo and download links can be
8found on the project's website: <https://ldgallery.pacien.org>.
7 9
8 10
9Build 11Usage and build (using the Nix Flake)
10----- 12-------------------------------------
13
14This program is available as a Nix Flake allowing to build both the viewer
15and compiler components and assemble those automatically.
16
17The following commands are available on NixOS, or a Linux or MacOS system
18having the Nix package manager installed:
19
20* Just running the program (compiler with bundled viewer):
21 * Using the latest release: `nix run github:ldgallery/ldgallery -- --help`
22 * Using a local source checkout: `nix run .# -- --help`
23
24* Building individual components locally:
25 `nix build .#{compiler,viewer,man} --print-build-logs`
26
27
28Manual build
29------------
30
31Without using the Nix Flake, the project can be built as follows:
11 32
12* Compile the web _viewer_ as detailed in `./viewer/readme.md`. 33* Compile the web _viewer_ as detailed in `./viewer/readme.md`.
13* Copy/link the compiled _viewer_ to the _ldgallery compiler_ data directory. 34* Copy/link the compiled _viewer_ to the _ldgallery compiler_ data directory.