summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Makefile6
-rw-r--r--README.md4
2 files changed, 6 insertions, 4 deletions
diff --git a/Makefile b/Makefile
index 2a5c737..4ca73a6 100644
--- a/Makefile
+++ b/Makefile
@@ -17,14 +17,14 @@ VERSION = $(shell git describe --tags --long)
all: cqrlogo README.html cqrlogo.png
-cqrlogo: config.h
+cqrlogo: cqrlogo.c config.h
$(CC) $(CFLAGS) -o cqrlogo cqrlogo.c \
-DVERSION="\"$(VERSION)\""
config.h:
$(CP) config.def.h config.h
-README.html:
+README.html: README.md
$(MD) README.md > README.html
cqrlogo.png: cqrlogo
@@ -130,4 +130,4 @@ check:
$(GREP) -e '^This QR Code has been stolen from https://eworm.net/!$$'
clean:
- $(RM) -f *.o *~ *.png cqrlogo
+ $(RM) -f *.o *~ *.png README.html cqrlogo
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