commit 0f0976cd14d4b3b5944d37584871b6d2a9766db3
parent 01904e9911dfef9f8f3aabbf749c071f0465537c
Author: ctucx <c@ctu.cx>
Date: Sun, 24 May 2020 18:47:34 +0200
parent 01904e9911dfef9f8f3aabbf749c071f0465537c
Author: ctucx <c@ctu.cx>
Date: Sun, 24 May 2020 18:47:34 +0200
update readme
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md @@ -1,20 +1,31 @@ # ctucx' gallery a little introduction into this software. -## Install +## get it ```shell= [user@pc ~]$ git clone https://git.ctu.cx/ctucx/gallery/ [user@pc ~]$ cd gallery/ [user@pc ~]$ nimble build ``` -## Use the Programm +## use it ```shell= [user@pc ~]$ ./gallery <config.file> ``` -## Dependencies +## dependencies Dependencies: ImageMagick, nim >= 1.0.6, nimble -## Infos +## infos When running the program, a config file 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: medium: 1920x1080, thumbnail: 200x200 + +it's recommended to disable caching for the html files, here is an example config snippet for nginx: +``` +location ~* \.html$ { + add_header Last-Modified $date_gmt; + add_header Cache-Control 'private no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0'; + if_modified_since off; + expires off; + etag off; +} +```