ctucx.git: gallery

static-site-generator for image-galleries [used @ photos.ctu.cx]

commit 19162c7604ee821291c2f187d9c527358c8c396d
parent 435e4fcdb692281cc0b58c5883253b15bcde79aa
Author: y0sh <club-mate-cola@y0sh.net>
Date: Sun, 10 May 2020 00:45:44 +0200

add README
1 file changed, 25 insertions(+), 0 deletions(-)
A
README.md
|
25
+++++++++++++++++++++++++
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# How to ctucx picture_gallery
+
+a little Example for https://git.ctu.cx/ctucx/gallery/
+
+## Install
+```shell=
+[user@pc ~]$ git clone https://git.ctu.cx/ctucx/gallery/
+[user@pc ~]$ cd gallery/
+[user@pc ~]$ nimble build
+```
+
+## Use the Programm
+```shell=
+[user@pc ~]$ ./picture_gallery <source_dir> <target_dir>
+```
+
+## Dependencies
+Dependencies: Imagemagick, nim >= 1.0.6, nimble
+
+## Infos
+When running the program, a source folder and a destination folder must be specified, then the program creates all necessary HTML and CSS objects to display the pages correctly and creates images in the following sizes. Maximum 1920x1080 Thumbnail 200x200
+
+After the generation process, images are created in the following sizes.
+Maximum 1920x1080
+Thumbnail 200x200