Skip to content

Commit

Permalink
Some remarks on how to build the project (#9)
Browse files Browse the repository at this point in the history
* add some remarks on how to build the project
* working msvc builds are necessary to green ci
  • Loading branch information
yax-lakam-tuun authored May 28, 2021
1 parent 77987b4 commit cc2589d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/ci_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,3 @@ jobs:

- name: Run tests
run: ./test/win_run.ps1
continue-on-error: true

13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,21 @@ int main()
* gcc10 and libstdc++-10-dev or higher (see [`test/linux.Dockerfile`](test/linux.Dockerfile))
* msvc: Visual Studio 2019 16.10.0 (see [`test/win.Dockerfile`](test/win.Dockerfile))
* Not supported:
* clang doesn't seem to support all featured of C++20 needed to make this work
* macOS (due to lack of C++20 features), support will be added in the future

# How to build
* Since the library is header-only, building is actually not necessary.
* Just put the `include` folder of this project into your header search path and it should just work.
* However, if you'd like to run the tests, please select the top-level of the project in order to run _CMake_.
* For more information, please have a look at the _Dockerfile_ in the test folder and consider the remarks below.

## How to run the tests
If you would like to run the tests, one has to add the following cmake flag: `-DQRCODE_TESTS_ENABLED:BOOL=True`

## Debug builds using MSVC
Building with tests enabled in _Debug_ configuration won't build due to an issue in _Microsoft_'s STL implementation. _Release_ configuration works though.

# CI builds
CI builds usually consists of a test build and a conan demo build.
If and only if both builds were successful, the CI state is green.
Expand Down

0 comments on commit cc2589d

Please sign in to comment.