Skip to content

Commit 941adaf

Browse files
committed
Update README to describe new dependencies
1 parent e35ac6c commit 941adaf

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,31 @@ First, clone this repo, then make sure you have the dependencies. Acquiring the
1414

1515
I've tested this on Windows with Visual Studio 2017 and Linux using an Ubuntu instance running in WSL.
1616

17+
I plan on adding a vcpkg package for this project, and then you can install everything with `vcpkg install cppgraphqlgen`.
18+
1719
## Software dependencies
1820

1921
I picked a few projects as dependencies:
2022

21-
- JSON support: Microsoft's [cpprestsdk](https://github.com/Microsoft/cpprestsdk).
23+
- JSON support: [RapidJSON](https://github.com/Tencent/rapidjson).
2224
- 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.
2325
- Unit testing: [Google Test](https://github.com/google/googletest) for the unit testing framework.
2426

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.
27+
The build system for this project uses [CMake](http://www.cmake.org/). You'll need to have all 3 dependencies installed on your system along with CMake to build this project.
2628

2729
### Using vcpkg
2830

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.
31+
Vcpkg can install the dependencies from source on either platform, and that's what I'm using on Windows. Use `vcpkg install rapidjson pegtl gtest` to get all of them.
3032

31-
This approach works well on Linux. I've done all of my testing for Linux with WSL.
33+
This approach works well on Linux. I've done all of my testing for Linux with WSL using vcpkg.
3234

33-
### Windows
35+
### Windows with NuGet
3436

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).
37+
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) but still want to use a package manager.
3638

37-
### Linux
39+
### Linux or Windows from GitHub
3840

39-
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.
41+
Clone each of the repos from GitHub and follow the installation instructions in the README.md files.
4042

4143
## API references
4244

0 commit comments

Comments
 (0)