Skip to content

Commit

Permalink
Update Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Shihab-Shahriar committed Mar 11, 2024
1 parent 168bda5 commit 4f06009
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ OpenRAND is a C++ library designed to foster reproducible scientific research by


## Installation
OpenRAND is header only, so there is no need to install it. Simply copy the header files in `include/` directory into your project and you're good to go!
OpenRAND is header only, so there is no need to install it. You can simply copy the header files in `include/` directory into your project and you're good to go!

You can also install OpenRAND using CMake. To integrate OpenRAND into your CMake project, add the following lines to your CMakeLists.txt file:
You can also use CMake. To integrate OpenRAND into your CMake project, add the following lines to your CMakeLists.txt file:

```
include(FetchContent)
Expand All @@ -29,7 +29,11 @@ FetchContent_Declare(
FetchContent_MakeAvailable(crng)
```
If you're building OpenRAND and want to build the TestU01 statistical test suite, set CMake variable `TESTU01_PATH` to locally installed TestU01 library location. For practrand, pipe the output of `pract_rand*` executables (built bu default) to Practrand's `RNG_test` executable.

Alternatively, you can install OpenRAND by running `make install` from a build directory, and linking to it using `target_link_libraries(Executable PRIVATE OpenRAND::OpenRAND)` from an application.


You can optionally turn on tests, examples and benchmarks using `OpenRAND_ENABLE_TESTS`, `OpenRAND_ENABLE_EXAMPLES` and `OpenRAND_ENABLE_BENCHMARKS` flags respectively. If you want to build the TestU01 statistical test suite, set CMake variable `TESTU01_PATH` to locally installed TestU01 library location. For practrand, pipe the output of `pract_rand*` executables (built by default when testing enabled) to Practrand's `RNG_test` executable.


## Usage
Expand Down

0 comments on commit 4f06009

Please sign in to comment.