3 ms·

Kudos on the very thorough readme, complete with CMake instructions, most of the time people take it for granted that you know how to embed libraries and depend

• einpoklum 7y ago
  Actually, a detailed documentation belongs in a Wiki or a separate markdown document, that README.md is a bit much...
  • panpanna 7y ago
    The wiki is a GitHub thing and will not be included in your git clone. I personally prefer a doc/ folder with RST files in it. That's what the Linux kernel does.
    • frou_dh 7y ago
      Wikis on GitHub are themselves git repos and can be cloned separately: https://help.github.com/en/articles/adding-or-editing-wiki-pages#cloning-wikis-to-your-computer https://help.github.com/en/articles/adding-or-editing-wiki-p...
      • eropple 7y ago
        Yeah, but they have to be cloned separately. And not all projects have them. A doc directory gets you the same thing, easier.
        • frou_dh 7y ago
          Makes me wonder whether people have tried making the wiki repository a git submodule/subtree of the code repository.
• rienbdj 7y ago
  The fact that instructions are even required shows how poor the state of c++ packaging is.
  • dasloop 7y ago
    No, is not. The instructions are for users of the lib that are not using a package manager. If you are using one, in my case vcpkg, then no special instructions are required.