project_options icon indicating copy to clipboard operation
project_options copied to clipboard

Improve documentation

Open aminya opened this issue 3 years ago • 2 comments

  • [x] add a website for the documentation #198
  • [x] add instructions for making an executable #58
  • [x] add instructions for making a header-only library #58
  • [x] add instructions for making a normal library #58
  • [ ] add instructions for using doxygen-docs target
  • [ ] add instructions for using sanitizers (especially on windows)
  • [ ] adding more examples for using the options:
    • [ ] using PCH headers
    • [ ] using coverage
    • [ ] overriding compiler warnings,
    • [ ] adding more warnings
    • [ ] removing certain warnings for certain targets
  • [ ] documenting the individual functions (e.g. enable_doxygen) in case more control is needed
  • [ ] add documentation for cross-compilation

aminya avatar Feb 10 '22 08:02 aminya

Would be nice if we can use the github Wiki for some things. (Readme should really be an overview and link to the Wiki, IMHO)

For example what each Option do and how to uses them... What warnings gets enabled, link to best practices. Use of static code analyzers, sanitizers, how to enable them and why it matters (link to best practices)

Section for some util functions like run_vcpkg()

Some more Examples, Docker and maybe some Pitfalls...

abeimler avatar Jan 26 '23 12:01 abeimler

We can also have a dedicated website with documentation:

https://stackoverflow.com/a/32901179

https://gitlab.com/Pro1/doxygen-cmake-sphinx

aminya avatar Jan 26 '23 22:01 aminya