aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: bb10952f04612dcb4181bf317f913d965f555918 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# revela

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.

## Building

revela depends on GraphicsMagick (1.3+ tested) and libexif (0.6+ tested).
Optionally also depends on scdoc, if you want to build the man pages.

After just cloning, just need to execute this once:

```sh
git submodule update --init --recursive
```

Then you can proceed to build. This will build revela and generate man pages:

```sh
make
```

If you only want to build:

```sh
make revela
```

Or for debugging:

```sh
DEBUG=1 make revela
```

## 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.
* 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.