aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorpacien2022-09-04 18:18:27 +0200
committerpacien2022-09-04 18:18:27 +0200
commit11bbbae2850b9c45da697a8ed9626495a50a38c0 (patch)
treeff2713118f8b45d36905bfea2933f08d8e70066d /readme.md
parente93f7b1eb84c083d67567115284c0002a3a7d5fc (diff)
parent8349be992b46b77dee921f484cfbff8b758ff756 (diff)
downloadldgallery-11bbbae2850b9c45da697a8ed9626495a50a38c0.tar.gz
Merge branch 'develop': release v2.1v2.1
GitHub: related to #315
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md53
1 files changed, 36 insertions, 17 deletions
diff --git a/readme.md b/readme.md
index 6a438ca..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 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.
@@ -25,12 +46,13 @@ pandoc --standalone --to man viewer/ldgallery-viewer.7.md --output ldgallery-vie
25[Pandoc]: https://pandoc.org/ 46[Pandoc]: https://pandoc.org/
26 47
27 48
28License 49Copyright and license
29------- 50---------------------
30 51
31Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. 52Copyright (C) 2019-2022 Pacien TRAN-GIRARD and Guillaume FOUET.
32 53
33_ldgallery_ is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in `license.md`. 54_ldgallery_ is distributed under the terms of the GNU Affero General Public
55License v3.0, as detailed in `license.md`.
34 56
35Builds of this software embed and make use of the following libraries: 57Builds of this software embed and make use of the following libraries:
36 58
@@ -51,20 +73,17 @@ Builds of this software embed and make use of the following libraries:
51 * process, licensed under the BSD-3-Clause License 73 * process, licensed under the BSD-3-Clause License
52* Viewer (npm packages) 74* Viewer (npm packages)
53 * fortawesome/fontawesome-svg-core, licensed under the MIT License 75 * fortawesome/fontawesome-svg-core, licensed under the MIT License
54 * fortawesome/free-solid-svg-icons, licensed under the CC-BY-4.0 and MIT Licenses 76 * fortawesome/free-solid-svg-icons, licensed under the MIT License
55 * fortawesome/free-regular-svg-icons, licensed under the CC-BY-4.0 and MIT Licenses
56 * fortawesome/vue-fontawesome, licensed under the MIT License 77 * fortawesome/vue-fontawesome, licensed under the MIT License
57 * buefy, licensed under the MIT License 78 * vueuse/core, licensed under the MIT License
58 * core-js, licensed under the MIT License 79 * core-js, licensed under the MIT License
59 * hammerjs, licensed under the MIT License 80 * hammerjs, licensed under the MIT License
60 * marked, licensed under the MIT License 81 * marked, licensed under the MIT License
61 * resize-observer-polyfill, licensed under the MIT License 82 * mosha-vue-toastify, licensed under the MIT License
83 * pinia, licensed under the MIT License
62 * v-lazy-image, licensed under the MIT License 84 * v-lazy-image, licensed under the MIT License
63 * vue, licensed under the MIT License 85 * vue, licensed under the MIT License
64 * vue-class-component, licensed under the MIT License
65 * vue-dragscroll, licensed under the MIT License 86 * vue-dragscroll, licensed under the MIT License
66 * vue-i18n, licensed under the MIT License 87 * vue-i18n, licensed under the MIT License
67 * vue-property-decorator, licensed under the MIT License
68 * vue-router, licensed under the MIT License 88 * vue-router, licensed under the MIT License
69 * vuex, licensed under the MIT License 89
70 * vuex-class-component, licensed under the ISC License