vbe0201
Writing Quick Start instructions
Addresses #9.
I have provided an initial attempt at writing the Quick Start section of the documentation to illustrate how to build the templates.
I'd love to get your feedback on this so far and work with you in this PR to fill out more of the README.
Hello, thank you for helping out with the README, it's much appreciated! I've been meaning to write it for ages but never really had time and eventually lost track of it.
So far this is looking very good. What I would personally add to the quickstart section is a reference to the CMake documentation explaining toolchain files and some instructions for helping users set this up for their own projects, especially when they're rather new to CMake in general (which we kind of assume by explicitly mentioning the CMake download?).
That is, having to add the cmake/ directory and the toolchain file to the root of a project and subsequently building with the --toolchain flag. For autocompletion in IDEs like CLion, It might also be noteworthy to mention the addition of the -DCMAKE_TOOLCHAIN_FILE=DevkitA64Libnx.cmake option to CMake toolchain settings.
On a more general note, I'd like to suggest that we populate the readme in "batches" across multiple PRs so you don't have to do everything yourself and your efforts on this PR are not wasted in case you eventually lose interest in this. #9 could be used to track who is currently writing what.
Hi, I've put a small description regarding the arguments passed to cmake when building. Hopefully this covers things.
Regarding the command arguments for cmake toolchain, I'm not sure what the difference is between --toolchain and -D CMAKE_TOOLCHAIN_FILE, since CLion gives me autocomplete either way. I'll admit I'm still pretty inexperienced with CMake and C/C++ development as a whole, but I'll try my best to help out! :)
Perhaps it could be worth writing a second set of instructions for building with CLion, since that's probably a big reason to use this project.
I agree in breaking up the task of writing the README, I have retitled this PR to reflect this.
Just wondering since this seems to be 'stale'. What's the hold up on this? Cheers! 👍
