README,doc: Add subdirectory READMEs and clean up documenation by stotko · Pull Request #170 · stotko/stdgpu (original) (raw)
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation1 Commits6 Checks0 Files changed
Conversation
This file contains hidden or 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
[ Show hidden characters]({{ revealButtonHref }})
Although the documentation is linked at GitHub, these links are not easily discoverable in the README. Furthermore, users might look into doc/ to find the documentation which, however, will be a dead end. Add a dedicated section in the README to point at the documentation and create a local README in doc/ with the same section content. Furthermore, create a local README in examples/ as well to explain the structure and requirements of the examples. Finally, clean up the documentation style and remove unintuitive doxygen pages.
