Skip to content

Commit

Permalink
updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuDonofrio committed Jan 12, 2021
1 parent 38a865b commit aba7184
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,38 +214,41 @@ The following platforms and compilers are continously tested to work:

## Tests

`googletest` is used as our testing framework. CMake will sets all this up for your.
`googletest` is used as our testing framework. CMake will sets all this up for you.

All you need to do is to set the cmake option `XECS_BUILD_TESTING" to `ON`.
The cmake option `XECS_BUILD_TESTING` is used to determine if testing will be built.

Steps on windows using msvc:
Using visual studio:
* `cd build`
* `cmake -DXECS_BUILD_TESTING=ON ..`
* Open the generated solution
* Build and run the `test` project

Steps on linux:
Using make:
* `$ cd build`
* `$ cmake -DXECS_BUILD_TESTING=ON ..`
* `$ make`
* `$ ./test/tests`

## Benchmark
## Benchmarks

No dependancies are used for benchmarking.

All you need to do is to set the cmake option `XECS_BUILD_BENCHMAKING" to `ON`.
You must make sure your are in release mode, or else compiler optimizations wont be enabled and benchmarking will be quite pointless...

The cmake option `XECS_BUILD_BENCHMAKING` is used to determine if benchmarking will be built.

Using visual studio:
* `cd build`
* `cmake -DXECS_BUILD_TESTING=ON ..`
* `cmake -XECS_BUILD_BENCHMAKING=ON ..`
* Open the generated solution
* Build and run the `test` project
* Set your build to release mode
* Build and run the `benchmarks` project

Using make:
* `$ cd build`
* `$ cmake -XECS_BUILD_BENCHMAKING=ON ..`
* `$ cmake -DCMAKE_BUILD_TYPE=Release -XECS_BUILD_BENCHMAKING=ON ..`
* `$ make`
* `$ ./bench/benchmark`
* `$ ./bench/benchmarks`


0 comments on commit aba7184

Please sign in to comment.