Difference between revisions of "EBC Project Template"

From eLinux.org
Jump to: navigation, search
(Executive Summary)
m (Installation Instructions: Fixed typos)
 
(3 intermediate revisions by 2 users not shown)
Line 28: Line 28:
 
== Executive Summary ==
 
== Executive Summary ==
  
The title for our project speaks for itself. Our project was to create a News Display via Adafruit Neopixels LED matrix by gathering information from a reliable News API.
+
Give two sentence intro to the project.
  
Quite Useful and Innovative project on displaying of news grabbed from famous news channels on Colorful LED Matrices. This device is to be placed in a place of high crowd so as to make people aware of what is going around in this world.
+
Give two sentences telling what works.
  
Everything planned in starting, from API to final Visualizing news, is working fine even with many innovations.
+
Give two sentences telling what isn't working.
  
Not used wifi module which was our additional option to make our project wireless.Also, this is only prototype which can be easily made a proper product.
+
End with a two sentence conclusion.
  
Proper scheduled and timely efforts of our team managed to make a project as it was decided earlier, no loop-holes were left.
+
The sentence count is approximate and only to give an idea of the expected length.
  
 
== Packaging ==
 
== Packaging ==
Line 49: Line 49:
  
 
* 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 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.
+
* 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 one.
+
* 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 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 a Makefile for your code if you use a compiled language.
Line 61: Line 61:
 
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.
  
News acquisition from Z-News RSS-Feed.
+
== Highlights ==
 
Attractive and Attention Catching display.
 
  
Cascaded Design.
+
Here is where you brag about what your project can do.
  
Scrolling messages are displayed at the set pace.
+
Include a [http://www.youtube.com/ YouTube] demo.
 
 
Announcements and updates can be made.
 
 
 
Economically cheap as we used blocks of smaller matrices than one big matrix.
 
  
 
== Theory of Operation ==
 
== Theory of Operation ==
Line 77: Line 71:
 
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.
 
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.
  
Onkar Singh
+
== Work Breakdown ==
News Ticker Design and Coding, Final Wiki
 
 
 
Guntuku Vikas
 
News Ticker Design and coding, Poster Making.
 
  
Rajat Valecha
+
List the major tasks in your project and who did what.
API Interfacing
 
  
Text messages via GSM module.(Only authenticate users can send message, that will be displayed on the Matrix Model).
+
Also list here what doesn't work yet and when you think it will be finished and who is finishing it.
  
Announcement in Speech.(Using Text to Speech Converter, Speaker can be added to the project)
+
== Future Work ==
  
Developing an API for the Institute.
+
Suggest addition things that could be done with this project.
  
 
== Conclusions ==
 
== Conclusions ==

Latest revision as of 03:16, 27 November 2015

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 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.




thumb‎ Embedded Linux Class by Mark A. Yoder