Hello! I’m relatively new to C++; I’ve been learning for a couple of weeks. I created a small game using Raylib. However, I’m pretty confused about how to present my C++ project on GitHub. I was wondering, what’s the best way? Should I use CMake? I’m not sure. Most GitHub repositories I see don’t include the library they used (like Raylib) in their repo, so I’m pretty confused. Are users expected to install and link the dependencies themselves? Any help would be appreciated!
#Best way to present C++ projects? (on Github)
glad abyss
runic portal
Hello! I’m relatively new to C++; I’ve been learning for a couple of weeks. I cr...
basically CMake handles dependencies for you
Libraries and all other stuff
CMake is the building system for C++ Code
You are not expected to use CMake however it makes everything easier. CMake basically supports all build systems. Basically CMake makes build systems (Like make, ninja, etc...) And makes it available to your users.
I'd recommend you add a readme file it makes it much clearer
Add how to build your project
What dependencies were used. (You can do that automatically by downloading the libraries in CMake)
And all other details
Do not include a built version of your application (Thats what release is for)
Do not include non-relevant files and folders to your code (Like testcode.cpp or TestHowToDoThis which are not related to the working of the project).
theres alot of other stuff too. But you get the point. include every detail about your project. Not too much and not too little