Skip to content

Commit

Permalink
Updated the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
SkyToGround committed May 12, 2020
1 parent 9bd42a8 commit 0470345
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ cmake ..
make install
```

#### Making a conan package
If you are creating a conan package of this library you should disable CMake from running Conan by providing the following argument to CMake: `-DCONAN=DISABLE`. Furthermore, you must also use the `cmake_find_package` generator for CMake to be able to find the dependencies.

#### System installed dependencies
If using conan is not an option, it is possible to build the library using system installed dependencies. This requires a bit more work though and might not be as reliable.

Expand Down
8 changes: 8 additions & 0 deletions documentation/changes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
## Changes

### Version 2.0.2
* Made important CMkae changes required for properly making Conan packages. (ed-alertedh)
* Made minor changes to the code to prevent issues when using a `using namespace std;` statement.
* Minor documentation changes.

### Version 2.0.1
* Fixed faulty CMake code that did not properly import dependencies.

### Version 2.0.0
* Added performance tests.
* Replaced the home-brewed concurrent queue with a *much* faster open source one.
Expand Down

0 comments on commit 0470345

Please sign in to comment.