template-project-cpp icon indicating copy to clipboard operation
template-project-cpp copied to clipboard

Published 20 hours ago • verified publisher icon OxfordRSE

documentation

Open martinjrobins opened this issue 7 years ago • 2 comments

The template project still needs plenty of documentation to explain what each bit is doing:

  • [x] CMakeLists.txt
  • [x] MyLibrary.{cpp,hpp}
  • [x] MyTests.cpp
  • [x] travis.yml
  • [x] appveyor.yml
  • [x] codecov
  • [x] clang-format
  • [x] clang-tidy

martinjrobins avatar May 08 '18 09:05 martinjrobins

I'm thinking we keep minimal comments in the source code, so that people can quickly adapt it to their needs, but document everything fully elsewhere. Perhaps in the README.md?

martinjrobins avatar May 10 '18 10:05 martinjrobins

ahhhh, I accidentally added a whole lot of commits for this issue in #4. However, I think this is almost it for documentation. Anything else?

martinjrobins avatar Jun 10 '18 06:06 martinjrobins