NobleEngine
NobleEngine copied to clipboard
Provide better instructions for using this repo as a submodule with the Project Template
I think I underestimated how fiddly git submodules are for people who haven't used them before, or rather, I didn't explain them well enough. I should add more thorough instructions to the README file, including workflows for both command line and GUI clients.
See: https://discord.com/channels/675983554655551509/980931046545690705/1008522731479904357
The main thing is that I always want Noble Engine to be easy as possible for users starting from scratch, with literally no knowledge of Lua or any dev tooling, and I'm willing to sacrifice a lot for that.
The easiest for someone without any knowledge of Lua, tooling or even git would be to download a zip, unzip it and get started coding. That's what users are currently doing on Discord because they don't really know how to use git
or git submodule
. What about officially bundling the latest version of NobleEngine with the Project Template and point to this in the README or in GitHub Releases? This could potentially be automated with GitHub's CI.
Very low-tech for sure but this would prevent people from downloading both as .zip separately, and then asking where they should drop which folder. This could be offered alongside the current git submodule
approach (and btw I can work on a PR that documents it)
This has now been addressed by https://github.com/NobleRobot/NobleEngine-ProjectTemplate/issues/5
The suggestion to prove an option to bundle everything as one download is a good one (especially if it can be automated, something outside my expertise), but it's also kinda a lateral UX move to change from a single two-step process to two processes (one single-step and one two-step).
But I'm open to revisiting it in the future, perhaps linking it to how we set up official numbered releases. I think right now the project just doesn't have the time/support to make it happen reliably, so more robust documentation is the answer for now.