Skip to content
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 and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Documentation #44

Closed
6 tasks
ryanmrichard opened this issue Jan 19, 2022 · 0 comments · Fixed by #87
Closed
6 tasks

Better Documentation #44

ryanmrichard opened this issue Jan 19, 2022 · 0 comments · Fixed by #87

Comments

@ryanmrichard
Copy link
Contributor

In preparation for a 1.0 we need to improve the documentation. As motivation for what we should strive for, take a look at CMinx's documentation. In particular we need:

  • Brief description of CMakeTest on the home page
  • Installation instructions
  • Quickstart
  • Detailed instructions (some of this is already there; I'd integrate the tutorials into this part)
  • Background section (describe the design, compare to other solutions, etc.)
  • Developer documentation (API documentation plus some diagrams describing how CMakeTest is implemented)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant