README,doc: Add subdirectory READMEs and clean up documenation #170
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #170 +/- ##
=======================================
Coverage 97.80% 97.80%
=======================================
Files 28 28
Lines 1825 1825
=======================================
Hits 1785 1785
Misses 40 40 Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although the documentation is linked at GitHub, these links are not easily discoverable in the
README. Furthermore, users might look intodoc/to find the documentation which, however, will be a dead end. Add a dedicated section in theREADMEto point at the documentation and create a localREADMEindoc/with the same section content. Furthermore, create a localREADMEinexamples/as well to explain the structure and requirements of the examples. Finally, clean up the documentation style and remove unintuitive doxygen pages.