Documentation Update #17
Closed
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
Change `optionnal` to `optional` Change `Les` to `Let`
Documentation mentions `make benchmark` which should be `make slambench`.
Sightly adjusted the hierarchy to provide quicker access to sections of the documentation via header links. Moved FAQs down hierachy to more clearly explain what SLAMBench is at the beginning of the docuement and specific details further down. Removed TODO List – this is better suited to either a GitHub issue or project board. Few typos fixed: downdload, usescases and repart.
`?` were causing problems in the links.
Updated headers to single sided hashes, fixing issue with visible hashes. Converted inline code references to single backticks instead of multiple. Added syntax highlighting for code blocks by listing keyword type after opening backticks.
Changed if checking from -f to -d since it is checking directories and not files and was previously showing not found for any of the usecases regardless of their actual status. Removed some surplus -e parameters that were being displayed as text.
|
For this PR I feel like it's probably better if we make a PR straight to the main pamela repository. It's likely that it will take some time before we integrate everything that's being pushed to master on this repository, and these changes will be useful for anyone using the framework before we get to push the new stuff. |
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.
I've done a quick tidy up of the README.md:
I have slightly changed the hierarchy, so let me know what you think!