about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2021-01-14 18:57:10 +0100
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2021-01-14 18:57:10 +0100
commitb0645706f80da999c9a0b8ae0cf96bc0c3110d6b (patch)
tree334b4238d0ac47d6639af55c5a1d9888de056137 /README.md
parent01fc20da396c4e99b6e0f92105e76a7d40dfbc88 (diff)
downloadgal-b0645706f80da999c9a0b8ae0cf96bc0c3110d6b.tar.gz
gal-b0645706f80da999c9a0b8ae0cf96bc0c3110d6b.zip
Add readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..081b926
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# gal
+
+Yet another photo gallery generator.
+
+## Why?
+
+I could not find any other working solution that would be simple. This script just resizes all images and generates grid menu for them. That is all.
+
+## Usage
+
+```
+nix shell github:19pdh/gal
+
+gal [PHOTOS DIR] [OUTPUT DIR]
+```