summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2013-07-16 12:54:59 +0200
committerGravatar Christian Hesse <mail@eworm.de>2013-07-16 12:54:59 +0200
commite8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5 (patch)
tree58a1a7961184f938fdac8974b543133638ca1c46 /README.md
parent17c8c5afde52a2239eeaae1cd4d240e07cff13b6 (diff)
downloadcqrlogo-e8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5.tar.gz
cqrlogo-e8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5.tar.zst
doc and Makefile updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 198127d..fc21dad 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,7 @@ To compile and run `cqrlogo` you need:
* [libpng](http://www.libpng.org/pub/png/libpng.html)
* [zlib](http://www.zlib.net/) (which is a dependency for libpng)
* [qrencode](http://megaui.net/fukuchi/works/qrencode/index.en.html)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation)
Additionally it is expected to have `make` and `pkg-config` around to
successfully compile.
@@ -38,7 +39,8 @@ followed by:
> make install
-This will place an executable at `/usr/share/webapps/cqrlogo/cqrlogo`.
+This will place an executable at `/usr/share/webapps/cqrlogo/cqrlogo`,
+documentation can be found in `/usr/share/doc/cqrlogo/`.
The file `config.h` (copy from `config.def.h` if it does not exist) provides
some build time configuration, so feel free to make your changes there and