Difference between revisions of "ECE497 Project Template"

From eLinux.org
Jump to: navigation, search
m (Grading Template)
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:ECE497 |Project]]
+
[[Category:ECE497 |DotRun]]
 
{{YoderHead}}
 
{{YoderHead}}
  
Team members: [[user:Yoder|Mark A. Yoder]], (List all the team members here with link to their eLinux User page.  Use my format.
+
Team members: [[user:Yoder|Mark A. Yoder]], (List all the team members here with link to their eLinux User page.  Use my format.)
  
 
== Grading Template ==
 
== Grading Template ==
Line 10: Line 10:
 
<pre style="color:red">
 
<pre style="color:red">
 
00 Executive Summary
 
00 Executive Summary
00 Installation Instructions
+
00 Installation Instructions  
 
00 User Instructions
 
00 User Instructions
 
00 Highlights
 
00 Highlights
Line 19: Line 19:
 
00 Demo
 
00 Demo
 
00 Late
 
00 Late
Comments:
+
Comments: I'm looking forward to seeing this.
  
Score:  00/100
+
Score:  10/100
 
</pre>
 
</pre>
 +
 +
<span style="color:red">(Inline Comment)</span>
  
 
== Executive Summary ==
 
== Executive Summary ==
Line 35: Line 37:
  
 
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].  
 +
* 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 you code.
 
* Include any additional packages installed via '''opkg'''.
 
* Include any additional packages installed via '''opkg'''.
 
* Include kernel mods.
 
* Include kernel mods.

Revision as of 19:20, 1 November 2013

thumb‎ Embedded Linux Class by Mark A. Yoder


Team members: Mark A. Yoder, (List all the team members here with link to their eLinux User page. Use my format.)

Grading Template

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

00 Executive Summary
00 Installation Instructions 
00 User Instructions
00 Highlights
00 Theory of Operation
00 Work Breakdown
00 Future Work
00 Conclusions
00 Demo
00 Late
Comments: I'm looking forward to seeing this.

Score:  10/100

(Inline Comment)

Executive Summary

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 you code.
  • Include any additional packages installed via opkg.
  • 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.

Highlights

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

Include a YouTube demo.

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