Difference between revisions of "ECE434 Project Template"

From eLinux.org
Jump to: navigation, search
m (Grading Template)
 
(39 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:ECE497]]
+
[[Category:ECE497 |PT]]
 +
[[Category:ECE434Fall2020 |PT]]
 +
{{YoderHead}}
  
Team members: [[user:Yoder|Mark A. Yoder]], (List all the team members here with link to their eLinux User pageUse my format.
+
Team members: [[user:Yoder|Mark A. Yoder]]
 +
 
 +
== Grading Template ==
 +
I'm using the following template to grade.  Each slot is 10 points.
 +
0 = Missing, 5=OK, 10=Wow!
 +
 
 +
<pre style="color:red">
 +
Add Extras
 +
 
 +
09 Executive Summary
 +
09 Packaging
 +
09 Installation Instructions
 +
09 User Instructions
 +
09 Highlights
 +
09 Theory of Operation
 +
09 Work Breakdown
 +
09 Future Work/Conclusions
 +
09 Hackster.io
 +
09 Demo/Poster
 +
00 Not Late
 +
 
 +
Score: 90/100
 +
</pre>
  
 
== Executive Summary ==
 
== Executive Summary ==
 +
 +
Picture that summarizes the project.
  
 
Give two sentence intro to the project.
 
Give two sentence intro to the project.
Line 14: Line 40:
  
 
The sentence count is approximate and only to give an idea of the expected length.
 
The sentence count is approximate and only to give an idea of the expected length.
 +
 +
== Packaging ==
 +
If you have hardware, consider [http://cpprojects.blogspot.com/2013/07/small-build-big-execuition.html Small Build, Big Execuition] for ideas on the final packaging.
  
 
== Installation Instructions ==
 
== Installation Instructions ==
  
Give step by step instructions on how to install your project on the SPEd2 image.   
+
Give step by step instructions on how to install your project.   
  
* Include your [https://github.com/ github] path as a link like this:  [https://github.com/MarkAYoder/gitLearn https://github.com/MarkAYoder/gitLearn].
+
* Include your [https://github.com/ github] path as a link like this to the read-only git site:  [https://github.com/MarkAYoder/gitLearn https://github.com/MarkAYoder/gitLearn].  
* Include any additional packages installed via '''opkg'''.
+
* Be sure your README.md is includes an up-to-date and clear description of your project so that someone who comes across you git repository can quickly learn what you did and how they can reproduce it.
 +
* Include a Makefile for your code if using C.
 +
* Include any additional packages installed via '''apt'''.  Include '''install.sh''' and '''setup.sh''' files.
 
* Include kernel mods.
 
* Include kernel mods.
 
* If there is extra hardware needed, include links to where it can be obtained.
 
* If there is extra hardware needed, include links to where it can be obtained.
Line 27: Line 58:
  
 
Once everything is installed, how do you use the program?  Give details here, so if you have a long user manual, link to it here.
 
Once everything is installed, how do you use the program?  Give details here, so if you have a long user manual, link to it here.
 +
 +
Consider making it autostart for full credit.
  
 
== Highlights ==
 
== Highlights ==
Line 32: Line 65:
 
Here is where you brag about what your project can do.
 
Here is where you brag about what your project can do.
  
Consider including a [http://www.youtube.com/ YouTube] demo.
+
Include a [http://www.youtube.com/ YouTube] demo the audio description.
  
 
== Theory of Operation ==
 
== Theory of Operation ==
Line 43: Line 76:
  
 
Also list here what doesn't work yet and when you think it will be finished and who is finishing it.
 
Also list here what doesn't work yet and when you think it will be finished and who is finishing it.
 +
 +
== Future Work ==
 +
 +
Suggest addition things that could be done with this project.
  
 
== Conclusions ==
 
== Conclusions ==
  
 
Give some concluding thoughts about the project. Suggest some future additions that could make it even more interesting.
 
Give some concluding thoughts about the project. Suggest some future additions that could make it even more interesting.
 +
 +
{{YoderFoot}}

Latest revision as of 10:32, 18 November 2021

thumb‎ Embedded Linux Class by Mark A. Yoder


Team members: Mark A. Yoder

Grading Template

I'm using the following template to grade. Each slot is 10 points. 0 = Missing, 5=OK, 10=Wow!

Add Extras

09 Executive Summary
09 Packaging
09 Installation Instructions 
09 User Instructions
09 Highlights
09 Theory of Operation
09 Work Breakdown
09 Future Work/Conclusions
09 Hackster.io
09 Demo/Poster
00 Not Late

Score:  90/100

Executive Summary

Picture that summarizes the project.

Give two sentence intro to the project.

Give two sentences telling what works.

Give two sentences telling what isn't working.

End with a two sentence conclusion.

The sentence count is approximate and only to give an idea of the expected length.

Packaging

If you have hardware, consider Small Build, Big Execuition for ideas on the final packaging.

Installation Instructions

Give step by step instructions on how to install your project.

  • Include your github path as a link like this to the read-only git site: https://github.com/MarkAYoder/gitLearn.
  • Be sure your README.md is includes an up-to-date and clear description of your project so that someone who comes across you git repository can quickly learn what you did and how they can reproduce it.
  • Include a Makefile for your code if using C.
  • Include any additional packages installed via apt. Include install.sh and setup.sh files.
  • Include kernel mods.
  • If there is extra hardware needed, include links to where it can be obtained.

User Instructions

Once everything is installed, how do you use the program? Give details here, so if you have a long user manual, link to it here.

Consider making it autostart for full credit.

Highlights

Here is where you brag about what your project can do.

Include a YouTube demo the audio description.

Theory of Operation

Give a high level overview of the structure of your software. Are you using GStreamer? Show a diagram of the pipeline. Are you running multiple tasks? Show what they do and how they interact.

Work Breakdown

List the major tasks in your project and who did what.

Also list here what doesn't work yet and when you think it will be finished and who is finishing it.

Future Work

Suggest addition things that could be done with this project.

Conclusions

Give some concluding thoughts about the project. Suggest some future additions that could make it even more interesting.




thumb‎ Embedded Linux Class by Mark A. Yoder