aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-03-31 02:06:41 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-03-31 02:06:41 +0300
commit3c7230c191ade30d5b9c8ef02a019ba42ab519f5 (patch)
tree7e85927e11ae604020c547cfe62c3aaa18cfe6f8 /README.md
parentc251b0d5a905f19498e1d3312041b794e57fd2f8 (diff)
downloadrevela-3c7230c191ade30d5b9c8ef02a019ba42ab519f5.tar.gz
revela-3c7230c191ade30d5b9c8ef02a019ba42ab519f5.zip
Ready for packagingv0.1.0
* Documentation * make install/uninstall * roscha truthy fix * Other fixes/improvements
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9d8e76c..5e8a2ee 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,6 @@ A static web image gallery generator. It optimizes images for the web and
generates HTML files to create a photo/image gallery web site ready to be served
by an HTML server.
-Alpha stages. It's functional but a little rough around the edges.
-
## Building
revela depends on GraphicsMagick (1.3+ tested) and libexif (0.6+ tested).
@@ -21,11 +19,13 @@ or for debugging:
DEBUG=1 make
```
+## Usage
+
+For information on how to use revela, consult `man revela` if installed on your
+system, or read the contents in `docs/` in the source.
+
## TODO:
* Add exif tags to template hashmap.
-* Improve unja or find better alternative.
-* Get rid of previews variable. It is a temporary hack to limit the amount of
- thumbnails for each album in the index.
* Better test coverage? (if I am not too lazy)
* Document.