You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README with project status and focus (#1639)
* Update README with project status and focus
Add project status and focus areas to README
* Update README.md
* docs: Restore maintainer disclaimers and fix Conan instructions
This commit adds back the warning about community-maintained package managers and the warning about the Amalgamated Source being possibly outdated to prevent misdirected issues. It also includes the necessary generators for Conan 2 in the README's Conan section to resolve issue #1629 while preserving the brevity of the new layout.
***`0.y.z`:** Legacy support for pre-C++11 compilers. Maintenance is limited to critical security fixes.
50
45
51
-
First, clone and set up `vcpkg`.
46
+
***`00.11.z`:** Discontinued.
52
47
53
-
```sh
54
-
git clone https://github.com/Microsoft/vcpkg.git
55
-
cd vcpkg
56
-
./bootstrap-vcpkg.sh
57
-
```
48
+
Major versions maintain binary compatibility. Critical security fixes are accepted for both the `master` and `0.y.z` branches.
58
49
59
-
Then, create a [vcpkg.json manifest](https://learn.microsoft.com/en-us/vcpkg/reference/vcpkg-json),
60
-
enabling manifest mode and adding JsonCpp to the manifest's dependencies list.
50
+
## Integration
61
51
62
-
```sh
63
-
vcpkg new --application
64
-
vcpkg add port jsoncpp
65
-
```
66
-
67
-
> [!NOTE]: you can use vcpkg in either classic mode or manifest mode (recommended).
68
-
69
-
#### Classic mode
52
+
> [!NOTE]
53
+
> Package manager ports (vcpkg, Conan, etc.) are community-maintained. Please report outdated versions or missing generators to their respective repositories.
70
54
71
-
If your project does not have a `vcpkg.json`,
72
-
your project is in [Classic mode](https://learn.microsoft.com/en-us/vcpkg/concepts/classic-mode)
73
-
you can install JsonCpp by directly invoking the `install` command:
55
+
### vcpkg
56
+
Add `jsoncpp` to your `vcpkg.json` manifest:
74
57
75
-
```sh
76
-
vcpkg install jsoncpp
58
+
```json
59
+
{
60
+
"dependencies": ["jsoncpp"]
61
+
}
77
62
```
78
63
79
-
### Manifest mode
64
+
Or install via classic mode: `vcpkg install jsoncpp`.
80
65
81
-
If your project *does* have a vcpkg.json manifest, your project is in [Manifest mode](https://learn.microsoft.com/en-us/vcpkg/concepts/manifest-mode)
82
-
and you need to add JsonCpp to your package manifest dependencies, then invoke
The JsonCpp package in Conan Center is kept up to date by [ConanCenterIndex](https://github.com/conan-io/conan-center-index)
113
-
contributors. If the version is out of date, please create an issue or pull request on the
114
-
Conan Center Index repository.
115
-
116
89
### Amalgamated source
117
90
118
-
See the [Wiki entry on Amalgamated Source](https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)).
91
+
> [!NOTE]
92
+
> This approach may be outdated.
119
93
120
-
### The Meson Build System
94
+
For projects requiring a single-header approach, see the [Wiki entry](https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated-(Possibly-outdated)).
121
95
122
-
If you are using the [Meson Build System](http://mesonbuild.com), then you can
123
-
get a wrap file by downloading it from [Meson WrapDB](https://mesonbuild.com/Wrapdb-projects.html),
124
-
or simply use `meson wrap install jsoncpp`.
125
-
126
-
### Other ways
96
+
## Documentation
127
97
128
-
If you have trouble, see the
129
-
[Wiki](https://github.com/open-source-parsers/jsoncpp/wiki), or post a question
130
-
as an Issue.
98
+
Documentation is generated via [Doxygen](http://open-source-parsers.github.io/jsoncpp-docs/doxygen/index.html).
99
+
Additional information is available on the [Project Wiki](https://github.com/open-source-parsers/jsoncpp/wiki).
131
100
132
101
## License
133
102
134
-
See the [LICENSE](./LICENSE) file for details. In summary, JsonCpp is licensed
135
-
under the MIT license, or public domain if desired and recognized in your
136
-
jurisdiction.
103
+
JsonCpp is licensed under the MIT license, or public domain where recognized.
0 commit comments