This PR includes updates to documentation and testing. The documentation updates revolve around
making this project more contributor friendly. It resolves the three missing components seen on the
community page.
The testing updates allow the unit tests to be run using ctest or make test, which improves the ease
of testing the software. We will no longer need to run the tests via bash scripts or even install them should we choose not to.
Related Issues
95 - Adds build status to README.
96 - CMake test support
98 - Updates the Community Documentation
Motivation and Context
We are looking to build a community of support, which starts with making it easy for them to get going with the project.
How Has This Been Tested?
Tested using Travis-CI. All of the updates that are included
here have been tested on that repository first. I have also compiled and run all unittests.
Note: : The links to the Code of Conduct and the Contributing document will not be live until this is pushed up to master.
Screenshots (if appropriate):
None
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[X] My code follows the code style of this project.
[x] My change requires a change to the documentation.
Description
This PR includes updates to documentation and testing. The documentation updates revolve around making this project more contributor friendly. It resolves the three missing components seen on the community page.
The testing updates allow the unit tests to be run using
ctest
ormake test
, which improves the ease of testing the software. We will no longer need to run the tests via bash scripts or even install them should we choose not to.Related Issues
95 - Adds build status to README.
96 - CMake test support
98 - Updates the Community Documentation
Motivation and Context
We are looking to build a community of support, which starts with making it easy for them to get going with the project.
How Has This Been Tested?
Tested using Travis-CI. All of the updates that are included here have been tested on that repository first. I have also compiled and run all unittests. Note: : The links to the Code of Conduct and the Contributing document will not be live until this is pushed up to master.
Screenshots (if appropriate):
None
Types of changes
Checklist: