diff options
author | Christian Hesse <mail@eworm.de> | 2013-07-16 12:54:59 +0200 |
---|---|---|
committer | Christian Hesse <mail@eworm.de> | 2013-07-16 12:54:59 +0200 |
commit | e8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5 (patch) | |
tree | 58a1a7961184f938fdac8974b543133638ca1c46 | |
parent | 17c8c5afde52a2239eeaae1cd4d240e07cff13b6 (diff) | |
download | cqrlogo-e8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5.tar.gz cqrlogo-e8abb5f58b5d04a8bdabcdd51efcff82d7b5e9e5.tar.zst |
doc and Makefile updates
-rw-r--r-- | Makefile | 6 | ||||
-rw-r--r-- | README.md | 4 |
2 files changed, 6 insertions, 4 deletions
@@ -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 @@ -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 |