Documentation mostly working as desired. Good enough for now. Added some topics.
This commit is contained in:
@@ -1,4 +1,18 @@
|
||||
# ECE4810-Fall2020-SunseekerTelemetry
|
||||
@mainpage
|
||||
|
||||
@b Subpages
|
||||
|
||||
- @subpage hardware
|
||||
|
||||
- @subpage software
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
# About
|
||||
|
||||
What this project is about (TODO)
|
||||
|
||||
|
||||
|
||||
@@ -6,6 +20,10 @@
|
||||
|
||||
For Documentation, we will use "doxygen" to easily create documentation pages for the project. This will be accessible in a variety of means, but primarily through HTML pages accessible through a browser, covering all aspects of the project.
|
||||
|
||||
More information here: @ref documentationGuide "Documentation Guide"
|
||||
|
||||
|
||||
|
||||
## Tips from Dr. Bazuin
|
||||
|
||||
- Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able
|
||||
@@ -29,5 +47,6 @@ For Documentation, we will use "doxygen" to easily create documentation pages fo
|
||||
|
||||
- Our requirements/specifications should be made to be more measurable
|
||||
- Need to design to safety standards, which need to be researched online
|
||||
- He said that he is available himself for anything power-related to help out with if needed
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user