Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.

Suggestions for making the code more accessible to new users #3

Open
looeee opened this issue Oct 30, 2019 · 1 comment
Open

Suggestions for making the code more accessible to new users #3

looeee opened this issue Oct 30, 2019 · 1 comment

Comments

@looeee
Copy link

looeee commented Oct 30, 2019

I'm taking a look through the code now, and it looks very clean and usable.

Two things that would make it even more accessible:

  • seperate demo and engine code. That is, put demo code in /demo/src and engine code in engine/src
  • In the absence of documentation, one or two line comments at the start of each file (or at least most important files). For example, ViewGroup - I'm guessing this is for organising visible objects into groups? It would be great if the purpose of this file was clearly stated at the top of the file. That would reduce the cognitive load of new users a lot as they get to grips with the engine.

For sure, if I spend even a day working with this engine these things will probably be obvious to me. But these changes would make me much more likely to consider using the code in the first place.

@Usnul
Copy link
Owner

Usnul commented Oct 30, 2019

That's a good point. The whole view concept is a bit superfluous, the engine can be used for the most part with react, vue or whatever else. It's just what i'm used to mostly.

Moving demo to a separate folder makes sense, it would be a tad more awkward for the build system configuration, but that's not very important.

I will invest some more time into comments though. Meantime, pull requests are welcome :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants