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

Add core documentation. #11

Open
nic-starke opened this issue Nov 2, 2023 · 0 comments
Open

Add core documentation. #11

nic-starke opened this issue Nov 2, 2023 · 0 comments
Assignees

Comments

@nic-starke
Copy link
Owner

The following documentation needs to be added:

Wiki

  • Project overview and goals.

  • FAQ

  • Download/Install Guide

  • Development

  • Scripts.

  • Formatting / Style guidelines.

  • .devcontainer explained.

  • Cross-compilation.

  • Flashing.

  • CI/CD workflow.

  • Testing

  • Firmware Features

  • Design process, decisions, tradeoffs, etc.

  • Implementation.

  • Review.

  • Features that were removed.

  • RTOS.

  • Custom networking protocol.

  • CBOR serialisation.

  • Sysex transport.

  • AVR Development

  • AVR GCC

  • AVR LibC

  • AVRDude

  • XMEGA

  • Pros/Cons

  • Desktop/Standalone Configuration Editor

Source Code

  • Cleanup the existing in-source documentation
  • Add more documentation and comments :)
@nic-starke nic-starke moved this to Todo in NEON_SAMURAI Nov 2, 2023
@nic-starke nic-starke added this to the v0.1 Release milestone Nov 2, 2023
@nic-starke nic-starke removed this from the v0.1 Release milestone May 22, 2024
@nic-starke nic-starke self-assigned this Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant