aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-12-24 17:49:51 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-12-24 17:49:51 +0300
commitc855c750864d5cc26b5263babe0f542818f1c467 (patch)
treedee0852725860e655ef9f1e70a92c745b040097f /README.md
parent01482f7632e86a12b9ee6d97eafa1dafa712f84e (diff)
downloadrevela-c855c750864d5cc26b5263babe0f542818f1c467.tar.gz
revela-c855c750864d5cc26b5263babe0f542818f1c467.zip
Fix build for other people
* Change submodule url for roscha to public one. * Small improvement and clarification in README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index 14ab33e..92a1750 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,21 @@ by an HTML server.
revela depends on GraphicsMagick (1.3+ tested) and libexif (0.6+ tested).
+After just cloning, just need to execute this once:
+
+```sh
+git submodule update --init --recursive
```
-git submodule update --init
+
+Then you can proceed to build:
+
+```sh
make
```
-or for debugging:
+Or for debugging:
-```
+```sh
DEBUG=1 make
```
@@ -29,3 +36,7 @@ system, or read the contents in `docs/` in the source.
* Add exif tags to template hashmap.
* Better test coverage? (if I am not too lazy).
* Document templates.
+* Improve performance? by generating html in a separate thread, e.g. send the
+ jobs to a queue in a separate thread in order to render at the same time as
+ images are converted with GraphicsMagick. Not sure if it would actually
+ improve performance or be worth the added complexity.