liberatedsystems / RNode_Firmware_CE

RNode is an open, free and flexible digital radio interface with many uses
https://unsigned.io/rnode
GNU General Public License v3.0
51 stars 11 forks source link

Documentation of firmware design & execution flow #20

Open jacobeva opened 3 months ago

jacobeva commented 3 months ago

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 https://github.com/liberatedsystems/RNode_Firmware_CE/issues/18#issuecomment-2271709732