mirror of
https://github.com/JHUAPL/kami.git
synced 2026-01-09 19:47:58 -05:00
Bring the primary README up to speed
This commit is contained in:
37
README.md
37
README.md
@@ -1,18 +1,4 @@
|
||||
# C++ Library Template
|
||||
|
||||
# Features
|
||||
|
||||
* Multimodule library: Three libraries wrapped in a single namespace: `foo::bar`, `foo::cat` and `foo::dog`
|
||||
* Auto-generated EXPORT headers for Windows DLLs
|
||||
* Auto-generated CMake config files for installation
|
||||
* Unit tests
|
||||
* Conan Package Manager Integration
|
||||
* Gitlab-CI integration
|
||||
* Builds the library with gcc/clang verions
|
||||
* Tests that the find_package() method works
|
||||
* Builds the Conan Package
|
||||
* Tests the cmake, cmake_paths, and cmake_find_package generators work
|
||||
* **[to do]** CPack generation.
|
||||
# Kami is Agent-Based Modeling in Modern C++
|
||||
|
||||
# Compiling
|
||||
|
||||
@@ -26,15 +12,6 @@ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/kami -DBUILD_SHARED_LIBS:BOOL=TRUE
|
||||
cmake --build .
|
||||
ctest -C Debug
|
||||
cmake --build . --target install
|
||||
|
||||
mkdir build && cd build
|
||||
cmake .. -DCMAKE_PREFIX_PATH=/tmp/kami
|
||||
cmake --build .
|
||||
|
||||
export LD_LIBRARY_PATH=/tmp/kami/lib
|
||||
./test-bar
|
||||
./test-cat
|
||||
|
||||
```
|
||||
|
||||
# Conan Package Manager
|
||||
@@ -54,12 +31,10 @@ cd kami
|
||||
conan create . kami/develop
|
||||
```
|
||||
|
||||
## Using the Conan Package
|
||||
## Contribution guidelines
|
||||
|
||||
Once you have created the Conan package, you can then link to it from another
|
||||
application or library. There are three examples you can look at in the
|
||||
`test_cmake_install` folder.
|
||||
* Use [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/)
|
||||
|
||||
* Using [cmake generator](test_cmake_install/conan_cmake_generator)
|
||||
* Using [cake_paths generator](test_cmake_install/conan_cmake_paths_generator)
|
||||
* Using [cmake_find_package generator](test_cmake_install/conan_cmake_find_package_generator)
|
||||
## For more information
|
||||
|
||||
* James P. Howard, II <<james.howard@jhu.edu>>
|
||||
Reference in New Issue
Block a user