aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorctucx <c@ctu.cx>2020-05-24 18:47:34 +0200
committerctucx <c@ctu.cx>2020-05-24 18:47:34 +0200
commit516a7aba29b4f7503f5279c8c2de64d237419f4b (patch)
tree6c2daf97afca1dd028d8f5c679e8776134245dc4
parentbd9f7b8ad5f6966a0f4b01d5aa584f69b1329665 (diff)
downloadgallery-516a7aba29b4f7503f5279c8c2de64d237419f4b.tar.gz
gallery-516a7aba29b4f7503f5279c8c2de64d237419f4b.tar.bz2
gallery-516a7aba29b4f7503f5279c8c2de64d237419f4b.zip
update readme
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3f3342e..df05575 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,20 @@
# 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