From ae66b243690871f2daea5ae4b2a4669081d7c556 Mon Sep 17 00:00:00 2001
From: Eric Haszlakiewicz
Date: Wed, 8 Jun 2016 02:36:13 +0000
Subject: [PATCH] Mention that we're aiming to follow RFC 7159 now. Cause
README.md to show up in Doxygen output as the main page.
---
Doxyfile | 4 ++--
README.html | 4 +++-
README.md | 10 +++++++++-
3 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index da39aca..032819d 100644
--- 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 dc696af..a30c830 100644
--- a/README.html
+++ b/README.html
@@ -10,7 +10,9 @@
Overview
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.
+ JSON formatted strings back into the C representation of JSON objects.
+ It aims to conform to RFC 7159
+
Building
To setup JSON-C to build on your system please run configure and make.
diff --git a/README.md b/README.md
index bcd4e21..76b2140 100644
--- 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 RFC 7159
+
Building on Unix with `git`, `gcc` and `autotools`
--------------------------------------------------