From: David Llewellyn-Jones Date: Wed, 22 Apr 2020 19:41:03 +0000 (+0300) Subject: Add links to the documentation X-Git-Url: https://www.flypig.org.uk/git/?p=libcontrac.git;a=commitdiff_plain;h=c3ebdae7950f96ca7beb8f2a29b79b33f3ec3438 Add links to the documentation Added some links to the documentation in the README file. --- diff --git a/README.md b/README.md index 878b0e5..cc147f3 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,22 @@ See the draft specs: https://www.apple.com/covid19/contacttracing/ ## Install -If you have autoconf you can install as follows. +If you have autoconf you can install like this: ``` autoreconf --install ./configure make -make check make install ``` +You can also run the unit tests and build the +[documentation](https://www.flypig.co.uk/docs/libcontrac/): +``` +make check +make doxygen +``` + ## Usage Include header files. @@ -99,9 +105,11 @@ libcontrac is released under the GPL v2 Licence. Read COPYING for information on ## Contact and Links -More information can be found at: https://www.flypig.co.uk/contrac +Library home page: https://www.flypig.co.uk/contrac + +API documentation: https://www.flypig.co.uk/docs/libcontrac/ -The source code can be obtained from git: +Source code from git: ``` git clone git@www.flypig.org.uk:libcontrac ``` diff --git a/doxyfile.in b/doxyfile.in index 13d3f5a..6177bba 100644 --- a/doxyfile.in +++ b/doxyfile.in @@ -1125,7 +1125,7 @@ HTML_EXTRA_FILES = # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_HUE = 26 +HTML_COLORSTYLE_HUE = 258 #HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors