Difference between revisions of "EBC Project Template"
Sthejasbabu (talk | contribs) |
m (→Installation Instructions: Fixed typos) |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
{{YoderHead}} | {{YoderHead}} | ||
| − | Team members: | + | 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 28: | Line 28: | ||
== Executive Summary == | == 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 == | == 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. | |
| + | If you have wiring, include Frizing diagrams. | ||
== Installation Instructions == | == Installation Instructions == | ||
| + | Give step by step instructions on how to install your project. | ||
| − | + | * 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 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 file called '''install.sh''' which installs all the files/packages needed. These are the things that only need to be done once. | ||
| + | * Include a file called '''setup.sh''' which initializes everything. These are the things that need to be done every time you reboot the Bone. | ||
| + | * Include a Makefile for your code if you use a compiled language. | ||
| + | * Include any additional packages installed via '''apt-get'''. | ||
| + | * Include kernel mods. | ||
| + | * If there is extra hardware needed, include links to where it can be obtained. | ||
== User Instructions == | == 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 == | == Highlights == | ||
| − | + | Here is where you brag about what your project can do. | |
| − | + | ||
| + | Include a [http://www.youtube.com/ YouTube] demo. | ||
== Theory of Operation == | == 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 == | == Work Breakdown == | ||
| Line 64: | Line 79: | ||
== Future Work == | == 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. | |
| − | |||
| − | |||
{{YoderFoot}} | {{YoderFoot}} | ||
Latest revision as of 03:16, 27 November 2015
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.)
Contents
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 Not Late Comments: I'm looking forward to seeing this. Score: 00/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.
If you have wiring, include Frizing diagrams.
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 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 file called install.sh which installs all the files/packages needed. These are the things that only need to be done once.
- Include a file called setup.sh which initializes everything. These are the things that need to be done every time you reboot the Bone.
- Include a Makefile for your code if you use a compiled language.
- Include any additional packages installed via apt-get.
- 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.
Embedded Linux Class by Mark A. Yoder
