📝 add documentation for integration via vcpkg
This commit is contained in:
parent
abd829e6c6
commit
23e3b622aa
@ -1252,7 +1252,7 @@ If you are using [hunter](https://github.com/cpp-pm/hunter) on your project for
|
|||||||
|
|
||||||
If you are using [Buckaroo](https://buckaroo.pm), you can install this library's module with `buckaroo add github.com/buckaroo-pm/nlohmann-json`. Please file issues [here](https://github.com/buckaroo-pm/nlohmann-json). There is a demo repo [here](https://github.com/njlr/buckaroo-nholmann-json-example).
|
If you are using [Buckaroo](https://buckaroo.pm), you can install this library's module with `buckaroo add github.com/buckaroo-pm/nlohmann-json`. Please file issues [here](https://github.com/buckaroo-pm/nlohmann-json). There is a demo repo [here](https://github.com/njlr/buckaroo-nholmann-json-example).
|
||||||
|
|
||||||
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can use the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json). Please see the vcpkg project for any issues regarding the packaging.
|
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can install the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json) with `vcpkg install nlohmann-json` and follow the then displayed descriptions. Please see the vcpkg project for any issues regarding the packaging.
|
||||||
|
|
||||||
If you are using [cget](https://cget.readthedocs.io/en/latest/), you can install the latest development version with `cget install nlohmann/json`. A specific version can be installed with `cget install nlohmann/json@v3.1.0`. Also, the multiple header version can be installed by adding the `-DJSON_MultipleHeaders=ON` flag (i.e., `cget install nlohmann/json -DJSON_MultipleHeaders=ON`).
|
If you are using [cget](https://cget.readthedocs.io/en/latest/), you can install the latest development version with `cget install nlohmann/json`. A specific version can be installed with `cget install nlohmann/json@v3.1.0`. Also, the multiple header version can be installed by adding the `-DJSON_MultipleHeaders=ON` flag (i.e., `cget install nlohmann/json -DJSON_MultipleHeaders=ON`).
|
||||||
|
|
||||||
|
@ -110,7 +110,40 @@ If you are using [Buckaroo](https://buckaroo.pm), you can install this library's
|
|||||||
|
|
||||||
## vcpkg
|
## vcpkg
|
||||||
|
|
||||||
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can use the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json). Please see the vcpkg project for any issues regarding the packaging.
|
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can install the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json) with `vcpkg install nlohmann-json` and follow the then displayed descriptions. Please see the vcpkg project for any issues regarding the packaging.
|
||||||
|
|
||||||
|
??? example
|
||||||
|
|
||||||
|
1. Create the following files:
|
||||||
|
|
||||||
|
=== "CMakeLists.txt"
|
||||||
|
|
||||||
|
```cmake
|
||||||
|
--8<-- "integration/vcpkg/CMakeLists.txt"
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "example.cpp"
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
--8<-- "integration/vcpkg/example.cpp"
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install package:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
vcpkg install nlohmann-json
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Build:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake
|
||||||
|
cmake --build .
|
||||||
|
```
|
||||||
|
|
||||||
|
Note you need to adjust `/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake` to your system.
|
||||||
|
|
||||||
## cget
|
## cget
|
||||||
|
|
||||||
|
7
doc/mkdocs/docs/integration/vcpkg/CMakeLists.txt
Normal file
7
doc/mkdocs/docs/integration/vcpkg/CMakeLists.txt
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
project(json_example)
|
||||||
|
cmake_minimum_required(VERSION 2.8.12)
|
||||||
|
|
||||||
|
find_package(nlohmann_json CONFIG REQUIRED)
|
||||||
|
|
||||||
|
add_executable(json_example example.cpp)
|
||||||
|
target_link_libraries(json_example PRIVATE nlohmann_json::nlohmann_json)
|
9
doc/mkdocs/docs/integration/vcpkg/example.cpp
Normal file
9
doc/mkdocs/docs/integration/vcpkg/example.cpp
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
std::cout << json::meta() << std::endl;
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user