TP3 (Final Deliverable)
Due Fri 6-Dec, 3pm
This is part of the
Term Project Assignment.
See that document for more details.
- TP3 Grading Meeting
- TP3 Submission
- TP3 Grading Meeting
There is no progress update meeting for tp3. Instead,
you will have your TP3 Grading Meeting as described
in the Term Project Assignment.
- TP3 Submission
By the tp3 deadline, submit a single zip file to Autolab with the following:
- Updated Project Proposal (proposal.docx, proposal.pdf, or proposal.md)
This file should be named proposal.docx, proposal.pdf,
or proposal.md (that is, Word, PDF, or Markdown,
and no other formats),
and it should include this section:
- Updated TP2 Deliverables
These are the same deliverables as in tp2, only updated (if necessary)
to reflect the final state of your project:
- Project Title and Description
- Similar Projects
- Version Control / Backup Plan
- Tech List
- Storyboard
- Project Source Code (Final Version)
In the top level of your submission zip file,
include a folder named "src" that contains
all the Python source code for your project.
This submission must also contain any other files (images, music files, etc)
required for your project to run. However, if these non-Python files
would make the zip
file too large, then move some of the larger non-Python files into some other
online shared file location (that is accessible without a password)
and include in your submission a link to those other files.
- Readme File (readme.txt or readme.md)
In the file readme.txt or readme.md (so in plain text
or Markdown format, and no other format),
include these items:
- Project Title and Description
A short description of the project's name and what it does. This may be taken from your design docs.
- Run Instructions
How to run the project. For example, which file the user should run in an editor. If your project uses data/source files, also describe how the user should set those up.
Also list which libraries or module that need to be installed, if any,
along with a short description on how to install them.
- Shortcut Commands
A list of any shortcut commands that exist. Shortcut commands can be used to demonstrate specific features by skipping forward in a game or loading sample data. These can be very useful for when you are testing your code, too.
A competent programmer should be able to run your project after reading the readme file, so make sure to include all necessary files in your submission!
- Video Demo (with a link in video-demo.txt)
Important Note: since a video that reasonably closely follows our submission specs is essential for our grading purposes, we will not grade any project that does not include a reasonably well-made video. This means that you will receive a 0 without one.
This should be a 1-3 minute video (and no more than 5 minutes in any case) that captures the main idea of the project. It should show the most important, the most
technically interesting and sophisticated, and
simply the coolest features of the project, with narration to explain how it works.
This demo should not provide a full walkthrough of the whole project, and does not need to cover every single feature; think of it as more of a trailer for the project as a whole. Your video demo should be uploaded to YouTube (or some other video hosting service), and your submission on Autolab should include a file called video-demo.txt that contains a link to the uploaded video. Also, we must be able to access your
video without a password.
The quality of the video and audio does not need to meet any particular standard (as long as it meets your standards such that you would be happy to include it in your own portfolio). Feel free to use a video camera or a screen capture program to record. As for creating the videos, one approach is to use zoom -- create a meeting just with yourself, share the screen (with sound if you wish), record the meeting, and you're set. Also, on Macs, Quicktime is a great option. Another solid choice is Screencastify -- a Chrome plugin that can record the entire screen easily (not just Chrome), integrates directly with Drive and YouTube, and is overall really easy to use. That said, you can use any video creation software you wish. Also, note that parts of some demo videos may be selected to appear in the TP Lightning Round video.
Note: in addition to your video demo, you will give a very short live demo
of your project during your TP3 Grading Meeting.