You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was thinking of adding a Class Diagram and a simple explanation on how the classes correlate. Instead of having to read all of the API reference and the entire code to learn how the code works, people could start learning first on a high level explanation. This would be helpful for who wants to learn about the project and who wants to contribute later (that's my case).
The diagram could be something like this:
Alongside with a high level explanation. What you think @msiemens? I hope to hear from you before I create a pull request about this.
Regards,
Mateus Antonio
The text was updated successfully, but these errors were encountered:
I was thinking of adding a Class Diagram and a simple explanation on how the classes correlate. Instead of having to read all of the API reference and the entire code to learn how the code works, people could start learning first on a high level explanation. This would be helpful for who wants to learn about the project and who wants to contribute later (that's my case).
The diagram could be something like this:
Alongside with a high level explanation. What you think @msiemens? I hope to hear from you before I create a pull request about this.
Regards,
Mateus Antonio
The text was updated successfully, but these errors were encountered: