NobleEngine icon indicating copy to clipboard operation
NobleEngine copied to clipboard

Provide better instructions for using this repo as a submodule with the Project Template

Open Mark-LaCroix opened this issue 1 year ago • 1 comments

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

Mark-LaCroix avatar Aug 14 '22 23:08 Mark-LaCroix

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)

simjnd avatar Sep 07 '22 19:09 simjnd