generic-library/valijson
1
0
Fork 0
mirror of https://github.com/tristanpenman/valijson.git synced 2025-03-01 10:57:57 +01:00
Code Issues Projects Releases Wiki Activity

Update requirements in README file, add make wrapping more consistent.

Browse Source
This commit is contained in:
Tristan Penman 2014-03-01 08:59:43 +11:00
parent 4c9864de73
commit 46ac9159bd
1 changed files with 18 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -4,10 +4,9 @@ Valijson
Overview
--------
Valijson is a header-only JSON Schema Validation library for C++.
Valijson is a header-only [JSON Schema](http://json-schema.org/) Validation library for C++.
Valijson provides a simple validation API that allows you load schemas, and
validate documents created by one of several supported parser libraries.
Valijson provides a simple validation API that allows you load JSON Schemas, and validate documents loaded by one of several supported parser libraries.
License
-------
@ -15,33 +14,28 @@ License
Valijson is licensed under the Simplified BSD License. See the LICENSE file
for more information.
Supported parsers
-----------------
Valijson supports JsonCpp, RapidJson and Boost Property Trees. It has been
tested against the following versions of these libraries:
- jsoncpp 0.5.0
- rapidjson 0.1
- boost::property_tree 1.54
Dependencies
------------
Required:
- boost 1.54 (earlier versions may work, but have not been tested)
Optional
- gtest 1.6.0 (for building unit tests)
- jsoncpp 0.5.0 (for use of the JsonCppAdapter class)
- rapidjson 0.1 (for use of the RapidJsonAdapter class)
- boost 1.54
Valijson supports JSON documents loaded using JsonCpp, RapidJson and Boost Property Tree. It has been tested against the following versions of these libraries:
- [boost::property\_tree 1.54](http://www.boost.org/doc/libs/1_54_0/doc/html/boost_propertytree/synopsis.html)
- [jsoncpp 0.5.0](http://downloads.sourceforge.net/project/jsoncpp/jsoncpp/0.5.0/jsoncpp-src-0.5.0.tar.gz)
- [rapidjson 0.1](https://code.google.com/p/rapidjson/downloads/detail?name=rapidjson-0.1.zip)
Other versions of these libraries may work, but have not been tested.
JSON Schema Support
-------------------
Valijson supports most of the constraints defined in Drafts 3 and 4 of the JSON
Schema specification.
Valijson supports most of the constraints defined in [Draft 3](http://tools.ietf.org/search/draft-zyp-json-schema-03) and [Draft 4](http://tools.ietf.org/search/draft-zyp-json-schema-04) of the JSON Schema specification.
The exceptions for Draft 3 are:
- disallow
- divisibleBy
- extends
@ -51,6 +45,7 @@ The exceptions for Draft 3 are:
- refRemote
The exceptions for Draft 4 are:
- definitions
- format (optional)
- multipleOf
@ -62,19 +57,10 @@ Support for JSON References is in development.
Build instructions
------------------
A rudimentary Makefile has been included. Running 'make examples' will build
the example programs in the 'examples' directory. Running 'make check' will
build and run the gtest-based unit tests. Executables will be placed in 'bin'.
A rudimentary Makefile has been included. Running 'make examples' will build the example programs in the 'examples' directory. Running 'make check' will build and run the test suite. Executables will be placed in 'bin'.
An Xcode 5 project has also been provided, in the 'xcode' directory. Note that
in order to run the test suite, you may need to configure the working directory
for the 'test_suite' scheme.
An Xcode 5 project has also been provided, in the 'xcode' directory. Note that in order to run the test suite, you may need to configure the working directory for the 'test\_suite' scheme.
The Xcode project has been configured so that /usr/local/include is in the
include path, and /usr/local/lib is in the library path. These are the
locations that homebrew installed Boost on my test system.
The Xcode project has been configured so that /usr/local/include is in the include path, and /usr/local/lib is in the library path. These are the locations that homebrew installed Boost on my test system.
Doxygen documentation can be built by running 'doxygen' from the project root
directory. Generated documentation will be placed in 'doc/html'. Other relevant
documentation such as schemas and specifications have been included in the 'doc'
directory.
Doxygen documentation can be built by running 'doxygen' from the project root directory. Generated documentation will be placed in 'doc/html'. Other relevant documentation such as schemas and specifications have been included in the 'doc' directory.