Skip to content

Commit e5b3815

Browse files
committed
Update the README to describe new dependencies
1 parent 415a80e commit e5b3815

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@ I've tested this on Windows with Visual Studio 2017 and Linux using an Ubuntu in
1616

1717
## Software dependencies
1818

19-
I picked [cpprestsdk](https://github.com/Microsoft/cpprestsdk) for the JSON support, [libgraphqlparser](https://github.com/graphql/libgraphqlparser) for the GraphQL parsing, and [Google Test](https://github.com/google/googletest) for the unit testing framework. The build for all of these uses [CMake](http://www.cmake.org/).
19+
I picked a few projects as dependencies:
2020

21-
You'll need to have all 3 projects installed on your system along with CMake to build this project.
21+
- JSON support: Microsoft's [cpprestsdk](https://github.com/Microsoft/cpprestsdk).
22+
- GraphQL parsing: [Parsing Expression Grammar Template Library (PEGTL)](https://github.com/taocpp/PEGTL), which is part of [The Art of C++](https://taocpp.github.io/) library collection.
23+
- Unit testing: [Google Test](https://github.com/google/googletest) for the unit testing framework.
24+
25+
The build for all of these uses [CMake](http://www.cmake.org/). You'll need to have all 3 projects installed on your system along with CMake to build this project.
2226

2327
### Using vcpkg
2428

25-
Vcpkg can install the dependencies from source on either platform, and that's what I'm using on Windows. The Windows [installation instructions](https://github.com/Microsoft/vcpkg/blob/master/README.md) for [cpprestsdk](https://github.com/Microsoft/cpprestsdk) recommend it, and if you add the port I did for [graphqlparser](https://github.com/Microsoft/vcpkg/pull/3953) you can get both of them with this tool.
29+
Vcpkg can install the dependencies from source on either platform, and that's what I'm using on Windows. The Windows [installation instructions](https://github.com/Microsoft/vcpkg/blob/master/README.md) for [cpprestsdk](https://github.com/Microsoft/cpprestsdk) recommend it, and it has a port for `pegtl` which satisfies that dependency as well.
2630

27-
This approach works well on Linux as well, graphqlparser has been merged into the ports collection.
31+
This approach works well on Linux. I've done all of my testing for Linux with WSL.
2832

2933
### Windows
3034

31-
The [cpprestsdk](https://github.com/Microsoft/cpprestsdk) package should also be available in NuGet packages if you don't want to use [vcpkg](https://github.com/Microsoft/vcpkg).
32-
33-
However, the [libgraphqlparser](https://github.com/graphql/libgraphqlparser) project does not officially support building on Windows yet. I submitted another [pull request](https://github.com/graphql/libgraphqlparser/pull/67) to add that.
35+
All of these packages dependencies should also be available in NuGet packages if you don't want to use [vcpkg](https://github.com/Microsoft/vcpkg).
3436

3537
### Linux
3638

37-
Clone [libgraphqlparser](https://github.com/graphql/libgraphqlparser) and follow the installation instructions in the [README](https://github.com/graphql/libgraphqlparser/blob/master/README.md#building-libgraphqlparser). At some point it may prompt you to install additional components like Google Test.
38-
3939
Follow the Linux [installation instructions](https://github.com/Microsoft/cpprestsdk/blob/master/README.md#getting-started) for cpprestsdk. Again, it may pull in more dependencies.
4040

4141
## API references

0 commit comments

Comments
 (0)