diff options
author | pacien | 2022-09-04 14:28:52 +0200 |
---|---|---|
committer | pacien | 2022-09-04 14:28:52 +0200 |
commit | 79fd9e8be8618d69ebb9e50d82aa0eccac05a4e7 (patch) | |
tree | 270d1adeb6871dd5b9647067b4595c220b118195 | |
parent | 4abac5363eba3e701343bfbde6afa0ce361ffab4 (diff) | |
download | ldgallery-79fd9e8be8618d69ebb9e50d82aa0eccac05a4e7.tar.gz |
flake: add useful commands to readme
-rw-r--r-- | flake.nix | 5 | ||||
-rw-r--r-- | readme.md | 29 |
2 files changed, 26 insertions, 8 deletions
@@ -17,10 +17,7 @@ | |||
17 | # along with this program. If not, see <https://www.gnu.org/licenses/>. | 17 | # along with this program. If not, see <https://www.gnu.org/licenses/>. |
18 | 18 | ||
19 | { | 19 | { |
20 | description = '' | 20 | description = "A static web gallery generator with tags"; |
21 | A static generator which turns a collection of tagged pictures into a \ | ||
22 | searchable web gallery. | ||
23 | ''; | ||
24 | 21 | ||
25 | inputs = { | 22 | inputs = { |
26 | nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; | 23 | nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; |
@@ -1,13 +1,34 @@ | |||
1 | ldgallery | 1 | ldgallery |
2 | ========= | 2 | ========= |
3 | 3 | ||
4 | A static gallery generator which turns a collection of tagged pictures and media into a searchable web gallery. | 4 | A static gallery generator which turns a collection of tagged pictures and |
5 | media into a searchable web gallery. | ||
5 | 6 | ||
6 | The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org. | 7 | The complete list of features, the user manual, demo and download links can be |
8 | found on the project's website: <https://ldgallery.pacien.org>. | ||
7 | 9 | ||
8 | 10 | ||
9 | Build | 11 | Usage and build (using the Nix Flake) |
10 | ----- | 12 | ------------------------------------- |
13 | |||
14 | This program is available as a Nix Flake allowing to build both the viewer | ||
15 | and compiler components and assemble those automatically. | ||
16 | |||
17 | The following commands are available on NixOS, or a Linux or MacOS system | ||
18 | having 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 | |||
28 | Manual build | ||
29 | ------------ | ||
30 | |||
31 | Without 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. |