Skip to content

Commit

Permalink
add link to headers in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cieslarmichal authored Jun 27, 2024
1 parent dda9483 commit cba5b90
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@ purposes within C++ applications.
## Usage and Documentation

To properly use Faker C++ you must first consume the Faker library (see Consuming Library with CMake).
Once that is done, you need to include the proper header files depending on the module you wish to generate data from or
Once that is done, you need to include the proper [header](https://cieslarmichal.github.io/faker-cxx/files.html) file depending on the module you wish to generate data from or
use general include file `faker-cxx/Faker.h`.
The module header file names can be found in [docs](https://cieslarmichal.github.io/faker-cxx).

Below is an example of how to use Faker C++ in your code.

Expand Down

0 comments on commit cba5b90

Please sign in to comment.