Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of firmware design & execution flow #20

Open
jacobeva opened this issue Aug 6, 2024 · 0 comments
Open

Documentation of firmware design & execution flow #20

jacobeva opened this issue Aug 6, 2024 · 0 comments

Comments

@jacobeva
Copy link

jacobeva commented Aug 6, 2024

After discussion with @nathmo, he said it is likely a good idea to have a document explaining how the firmware functions. I agree.

A document should be drawn up that explains the overall design and execution flow of the firmware, so as to make it easier to navigate for those who wish to contribute to the project.

That said, this largely still ties in with issue #1, as generally the source code should be the documentation, suckless style. However, I do see how an overview document, and better documentation of the KISS interface in particular, would make RNode much easier to contribute to and utilise.

See #18 (comment)

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

No branches or pull requests

1 participant