From f2eac07129ec048a7988b72ea4bc8d0cd2fd7d18 Mon Sep 17 00:00:00 2001 From: Eric Hawicz Date: Fri, 29 Mar 2024 18:45:22 -0400 Subject: [PATCH] doxygen can't handle html on heading, split that to separate lines https://github.com/doxygen/doxygen/issues/10466 --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 04ac67f..fee4a42 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ \mainpage -`json-c` +json-c ======== 1. [Overview and Build Status](#overview) @@ -15,7 +15,8 @@ 7. [Linking to libjson-c](#linking) 8. [Using json-c](#using) -JSON-C - A JSON implementation in C + +JSON-C - A JSON implementation in C ----------------------------------- JSON-C implements a reference counting object model that allows you to easily @@ -29,7 +30,8 @@ if you already have json-c installed and ready to use. Home page for json-c: https://github.com/json-c/json-c/wiki -Getting Help + +Getting Help ------------ If you have questions about using json-c, please start a thread on @@ -47,7 +49,8 @@ features or large changes of any kind, please first start a discussion on the [forums](https://groups.google.com/forum/#!forum/json-c). -Building on Unix with `git`, `gcc` and `cmake` + +Building on Unix with `git`, `gcc` and `cmake` -------------------------------------------------- If you already have json-c installed, see [Linking to `libjson-c`](#linking) @@ -60,7 +63,8 @@ Build Status Test Status * [Coveralls](https://coveralls.io/github/json-c/json-c?branch=master) [![Coverage Status](https://coveralls.io/repos/github/json-c/json-c/badge.svg?branch=master)](https://coveralls.io/github/json-c/json-c?branch=master) -### Prerequisites: + +### Prerequisites: - `gcc`, `clang`, or another C compiler @@ -80,7 +84,8 @@ sudo apt install doxygen # optional sudo apt install valgrind # optional ``` -### Build instructions: + +### Build instructions: `json-c` GitHub repo: https://github.com/json-c/json-c @@ -116,7 +121,8 @@ google-chrome doc/html/index.html ``` -CMake Options + +CMake Options -------------------- The json-c library is built with [CMake](https://cmake.org/cmake-tutorial/), @@ -188,7 +194,8 @@ cmake-configure can take a few options. | disable-werror | Avoid treating compiler warnings as fatal errors | -Testing: + +Testing: ---------- By default, if valgrind is available running tests uses it. @@ -224,7 +231,8 @@ JSONC_TEST_TRACE=1 make test and check the log files again. -Building on Unix and Windows with `vcpkg` + +Building on Unix and Windows with `vcpkg` -------------------------------------------------- You can download and install JSON-C using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager: @@ -237,7 +245,8 @@ You can download and install JSON-C using the [vcpkg](https://github.com/Microso The JSON-C port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository. -Building for Android + +Building for Android ---------------------- Building on Android is now particularly well supported, but there @@ -261,7 +270,8 @@ cmake \ make install ``` -Linking to `libjson-c` + +Linking to `libjson-c` ---------------------- If your system has `pkgconfig`, @@ -298,7 +308,8 @@ cd build cmake -DCMAKE_PREFIX_PATH=/path/to/json_c/install/lib64/cmake .. ``` -Using json-c + +Using json-c ------------ To use json-c you can either include json.h, or preferably, one of the