Added class diagram example to README.md #379
Merged
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.
I start with the README.md and then the documentation in gh-pages. Right now the README.md is finished. As for the class diagram positioning issue, still need more time to understand the code and identify the positioning issue with some examples.
The table code in markdown is reformated for readability. Preformated code is not indented since if indented, the rendered page also shows unnecessary indentation. And added a
<p>
tag to the first image to make it look better.I have no access to the site where the other two example images are hold, so I put it in the
docs/img
directory, hope it's ok.