Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.
This repository was archived by the owner on Dec 12, 2025. It is now read-only.

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

Description

@looeee

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions