From 36ba63ee29e8d24dcd0d173560d42045210c0965 Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 27 Sep 2020 22:51:53 +0200 Subject: docs: update short description We're not limited to pictures anymore --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 6a438ca..831ecf8 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,7 @@ ldgallery ========= -A static gallery generator which turns a collection of tagged pictures 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. -- cgit v1.2.3 From c9ac0c75d9273d3df86e66f2dad830146b7b1008 Mon Sep 17 00:00:00 2001 From: Zero~Informatique Date: Thu, 1 Jul 2021 20:19:47 +0200 Subject: viewer: Upgraded dependencies for Vue 2 Removed obsolete deps core-js ; resize-observer-polyfill --- readme.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 831ecf8..1fede70 100644 --- a/readme.md +++ b/readme.md @@ -55,10 +55,8 @@ Builds of this software embed and make use of the following libraries: * fortawesome/free-regular-svg-icons, licensed under the CC-BY-4.0 and MIT Licenses * fortawesome/vue-fontawesome, licensed under the MIT License * buefy, licensed under the MIT License - * core-js, licensed under the MIT License * hammerjs, licensed under the MIT License * marked, licensed under the MIT License - * resize-observer-polyfill, licensed under the MIT License * v-lazy-image, licensed under the MIT License * vue, licensed under the MIT License * vue-class-component, licensed under the MIT License -- cgit v1.2.3 From 0441e9af8147bfa19f8163120849711b20d48f2b Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 4 Sep 2022 13:29:22 +0200 Subject: readme: update copyright and licenses --- readme.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 1fede70..73cd260 100644 --- a/readme.md +++ b/readme.md @@ -25,12 +25,13 @@ pandoc --standalone --to man viewer/ldgallery-viewer.7.md --output ldgallery-vie [Pandoc]: https://pandoc.org/ -License -------- +Copyright and license +--------------------- -Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. +Copyright (C) 2019-2022 Pacien TRAN-GIRARD and Guillaume FOUET. -_ldgallery_ is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in `license.md`. +_ldgallery_ is distributed under the terms of the GNU Affero General Public +License v3.0, as detailed in `license.md`. Builds of this software embed and make use of the following libraries: @@ -51,18 +52,17 @@ Builds of this software embed and make use of the following libraries: * process, licensed under the BSD-3-Clause License * Viewer (npm packages) * fortawesome/fontawesome-svg-core, licensed under the MIT License - * fortawesome/free-solid-svg-icons, licensed under the CC-BY-4.0 and MIT Licenses - * fortawesome/free-regular-svg-icons, licensed under the CC-BY-4.0 and MIT Licenses + * fortawesome/free-solid-svg-icons, licensed under the MIT License * fortawesome/vue-fontawesome, licensed under the MIT License - * buefy, licensed under the MIT License + * vueuse/core, licensed under the MIT License + * core-js, licensed under the MIT License * hammerjs, licensed under the MIT License - * marked, licensed under the MIT License + * marked, licensed under the MIT License + * mosha-vue-toastify, licensed under the MIT License + * "pinia, licensed under the MIT License * v-lazy-image, licensed under the MIT License * vue, licensed under the MIT License - * vue-class-component, licensed under the MIT License * vue-dragscroll, licensed under the MIT License * vue-i18n, licensed under the MIT License - * vue-property-decorator, licensed under the MIT License * vue-router, licensed under the MIT License - * vuex, licensed under the MIT License - * vuex-class-component, licensed under the ISC License + -- cgit v1.2.3 From 0babb9a7e4fe29ecbf41655ade8b1c04c79dac27 Mon Sep 17 00:00:00 2001 From: pacien Date: Sun, 4 Sep 2022 13:31:45 +0200 Subject: readme: fix typo --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 73cd260..955ebe6 100644 --- a/readme.md +++ b/readme.md @@ -59,7 +59,7 @@ Builds of this software embed and make use of the following libraries: * hammerjs, licensed under the MIT License * marked, licensed under the MIT License * mosha-vue-toastify, licensed under the MIT License - * "pinia, licensed under the MIT License + * pinia, licensed under the MIT License * v-lazy-image, licensed under the MIT License * vue, licensed under the MIT License * vue-dragscroll, licensed under the MIT License -- cgit v1.2.3 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 --- readme.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) (limited to 'readme.md') 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: . -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