Document Functionality Of Minimum Viable Product - Githubissues

StephenBerkner / BitBox

An Open Source Wi-Fi Enabled LED Sign

MIT License

1 stars 0 forks source link

Document Functionality Of Minimum Viable Product #6

Open StephenBerkner opened 3 years ago

StephenBerkner commented 3 years ago

Create documentation for every file in MVP:

OpenSourceSign
- .gitignore (Explain why this file is important: microchip studio, WiFiCoprocessor/credentials.lua, etc.)
- README.md (Fill this file with build instructions, etc.)
- MainProcessor
  - inc
    - matrix.h
    - spi.h
    - usart.h
  - scripts
    - character_generator.py
  - src
    - main.c
    - matrix.c
    - spi.c
    - usart.c
- WiFiCoProcessor
  - credentials.lua (Create documentation for why this file is not included and how to safely use it)
  - init.lua
  - main.lua

StephenBerkner commented 3 years ago

It's quickly seeming like this might change from documenting the MVP into documenting whatever the next version of the BitBox is. Likely driven by a single processor instead of dual processors.