Skip to content
Oren Mishali edited this page Mar 8, 2017 · 5 revisions

Guidelines for final presentation

The final presentation's meeting will last approximately 1 hour:

  • 10 minutes – you will give a PPT presentation.
  • 20 minutes – going over your README file and additional GitHub resources.
  • 30 minutes - going over the Scenarios that you have prepared.

PPT presentation

You need to produce a relatively short PPT file (10-15 slides) that explains the essence of your project to a target audience who is not familiar with the project. Note that the PPT file will be placed in our Lab's website. Imagine a visitor that wants to learn more about your project and opens the PPT file. What would you tell him/her?

Try not to make your PPT file boring (i.e., text only). Where appropriate, include screenshots, code samples, etc. Animations can also improve the reader experience.

README file

Produce a great README file within GitHub (or improve your existing one). Note that the README is targeted to a different audience: developers who are interested in using the product and maintainers. The README should include:

  • About the tool.
  • Detailed installation guidelines.
  • How to use the tool?
  • Tips for maintainers, e.g., key classes and methods.

Usage scenarios

Define 3-4 key usage scenarios that you will demonstrate during the meeting. By "demonstrate" we mean "live" demo of your developed tool. You are invited to consult with Oren about the most appropriate scenarios to choose.

Additional GitHub (Wiki) resources

Depending on your project, you should create Wiki pages describing aspects such as:

  • Description of the algorithms you used.
  • Description of results.
  • Description of the challenges you have faced.

Good luck!

Clone this wiki locally