aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-12-24 18:45:58 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-12-24 18:45:58 +0300
commitefd8f03262f5cfeedbf2bef0f05636088b39d679 (patch)
treecfc3858fb304da621f65a3dcafb27c6642f674ae
parentc855c750864d5cc26b5263babe0f542818f1c467 (diff)
downloadrevela-efd8f03262f5cfeedbf2bef0f05636088b39d679.tar.gz
revela-efd8f03262f5cfeedbf2bef0f05636088b39d679.zip
README: more info on building
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 92a1750..bb10952 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ 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:
@@ -14,16 +15,22 @@ After just cloning, just need to execute this once:
git submodule update --init --recursive
```
-Then you can proceed to build:
+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
+DEBUG=1 make revela
```
## Usage