Mention that we're aiming to follow RFC 7159 now.

Cause README.md to show up in Doxygen output as the main page.

diff --git a/Doxyfile b/Doxyfile
index da39aca24c14382789a94f57ce740ed79f7f529d..032819da279a569701b4fe988867251e6e275877 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -417,7 +417,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = 
+INPUT                  = README.md .
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -426,7 +426,7 @@ INPUT                  =
 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
 
-FILE_PATTERNS          = *.h
+FILE_PATTERNS          = *.h *.md
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 # should be searched for input files as well. Possible values are YES and NO. 

diff --git a/README.html b/README.html
index dc696af37b769e87c4a139a87f5f90505a2ec793..a30c830584c3eb87693579d9522e88402822a519 100644 (file)
--- a/README.html
+++ b/README.html
@@ -10,7 +10,9 @@
                <h3>Overview</h3>
                <p>JSON-C implements a reference counting object model that allows you to easily 
                construct JSON objects in C, output them as JSON formatted strings and parse 
-               JSON formatted strings back into the C representation of JSON objects.</p>
+               JSON formatted strings back into the C representation of JSON objects.
+               It aims to conform to <a href="https://tools.ietf.org/html/rfc7159">RFC 7159</a>
+               </p>
 
                <h3>Building</h3>
                <p>To setup JSON-C to build on your system please run <tt>configure</tt> and <tt>make</tt>.</p>

diff --git a/README.md b/README.md
index bcd4e219d3333e8fd9742d5bb3894f7793839e04..76b2140fa2cd363dbbd94ad4cface876738d6567 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
-`json-c`
+`json-c`                       {#mainpage}
 ========
 
+JSON-C - A JSON implementation in C
+-----------------------------------
+
+JSON-C implements a reference counting object model that allows you to easily 
+construct JSON objects in C, output them as JSON formatted strings and parse 
+JSON formatted strings back into the C representation of JSON objects.
+It aims to conform to <a href="https://tools.ietf.org/html/rfc7159">RFC 7159</a>
+
 Building on Unix with `git`, `gcc` and `autotools`
 --------------------------------------------------