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

Update readme

Browse Source
This commit is contained in:
Tristan Penman 2022-08-30 11:44:38 +12:00
parent 2cef1a6538
commit 008c7ca4f9
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -10,6 +10,10 @@ The goal of this project is to support validation of all constraints available i
## Usage ## Usage
Clone the repo, including submodules:
git clone --recurse-submodules git@github.com:tristanpenman/valijson.git
The following code snippets show how you might implement a simple validator using RapidJson as the underlying JSON Parser. The following code snippets show how you might implement a simple validator using RapidJson as the underlying JSON Parser.
Include the necessary headers: Include the necessary headers:
@ -155,7 +159,7 @@ Valijson can be integrated either as git submodule or with find_package().
Download this repository into your project Download this repository into your project
```bash ```bash
git clone https://github.com/tristanpenman/valijson <project-path>/third-party/valijson git clone --recurse-submodules https://github.com/tristanpenman/valijson <project-path>/third-party/valijson
``` ```
If your project is a git repository If your project is a git repository
@ -180,7 +184,7 @@ target_link_libraries(your-executable ValiJSON::valijson)
It is possible to install headers by running cmake's install command from the build tree. Once Valijson is installed, use it from other CMake projects using `find_package(Valijson)` in your CMakeLists.txt. It is possible to install headers by running cmake's install command from the build tree. Once Valijson is installed, use it from other CMake projects using `find_package(Valijson)` in your CMakeLists.txt.
```bash ```bash
# Install Valijson # Install Valijson
git clone --depth=1 git@github.com:tristanpenman/valijson.git git clone --recurse-submodules --depth=1 git@github.com:tristanpenman/valijson.git
cd valijson cd valijson
mkdir build mkdir build
cd build cd build