Currently the base library README doesn't provide enough information to the user/developer on what it is. Documenting your implementation and design is crucial, especially since multiple different teams will be using this as a tool for their own development. I know ya'll are just starting off with the project, but let's create this initial README so that we can iterate and improve it in the future.
Changes
The confluence page provides some good technical details. But keep in mind the purpose of this README. It is not to dump deep technical information about your project but is rather user-focused (How would some use and benefit from this project?). Your target audience are other students in the elec team looking to learn to use your firmware library.
What would they like to know? maybe...
Purpose of the base library
Features provided
User manual/instructions
High-level design
Specific information or notes about your design/implementation
And much more, be creative! If the information is too long it might deserve it's own page, create on under you base-libary/docs and link that on your main README.
Again will be treated as your primary location for teams to learn about your project. Confluence will be your team's internal more technical documentation.
Purpose
Currently the base library README doesn't provide enough information to the user/developer on what it is. Documenting your implementation and design is crucial, especially since multiple different teams will be using this as a tool for their own development. I know ya'll are just starting off with the project, but let's create this initial README so that we can iterate and improve it in the future.
Changes
The confluence page provides some good technical details. But keep in mind the purpose of this README. It is not to dump deep technical information about your project but is rather user-focused (How would some use and benefit from this project?). Your target audience are other students in the elec team looking to learn to use your firmware library.
What would they like to know? maybe...
And much more, be creative! If the information is too long it might deserve it's own page, create on under you base-libary/docs and link that on your main README.
Again will be treated as your primary location for teams to learn about your project. Confluence will be your team's internal more technical documentation.
Resources