Added information about how documentation will be created
This commit is contained in:
@@ -1,5 +1,11 @@
|
|||||||
# ECE4810-Fall2020-SunseekerTelemetry
|
# ECE4810-Fall2020-SunseekerTelemetry
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
## Tips from Dr. Bazuin
|
## Tips from Dr. Bazuin
|
||||||
|
|
||||||
- Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able
|
- Make sub-circuits/sub-designs for schematics to keep things organized and modular/copy-able
|
||||||
@@ -11,3 +17,5 @@
|
|||||||
|
|
||||||
- Our requirements/specifications should be made to be more measurable
|
- Our requirements/specifications should be made to be more measurable
|
||||||
- Need to design to safety standards, which need to be researched online
|
- Need to design to safety standards, which need to be researched online
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user