Browse Source

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

Cause README.md to show up in Doxygen output as the main page.
tags/json-c-0.13-20171207
Eric Haszlakiewicz 9 years ago
parent
commit
ae66b24369
3 changed files with 14 additions and 4 deletions
  1. +2
    -2
      Doxyfile
  2. +3
    -1
      README.html
  3. +9
    -1
      README.md

+ 2
- 2
Doxyfile View File

@@ -417,7 +417,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.


INPUT =
INPUT = README.md .


# If the value of the INPUT tag contains directories, you can use the # 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 # 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 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm # *.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 # 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. # should be searched for input files as well. Possible values are YES and NO.


+ 3
- 1
README.html View File

@@ -10,7 +10,9 @@
<h3>Overview</h3> <h3>Overview</h3>
<p>JSON-C implements a reference counting object model that allows you to easily <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 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> <h3>Building</h3>
<p>To setup JSON-C to build on your system please run <tt>configure</tt> and <tt>make</tt>.</p> <p>To setup JSON-C to build on your system please run <tt>configure</tt> and <tt>make</tt>.</p>


+ 9
- 1
README.md View File

@@ -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` Building on Unix with `git`, `gcc` and `autotools`
-------------------------------------------------- --------------------------------------------------




Loading…
Cancel
Save