How to Submit Projects

This document describes how to submit your homework assignments. To submit your homework file, follow these steps:

Check Your Work

Check your answers and solutions to make sure you have all the required information. Also, be sure to test your code to make sure it performs as specified.

Create a README.txt File

You must turn in a single README.txt file like the following for the entire assignment:

Name: Jane Programmer
Email: invincible@gmail.com
Programming Partner: Joe Partner
OS: Windows
Proj#: 3
Status: Completed
Files:
- paycheck.txt: lesson exercise completed
- questions.txt: lesson exercise 1.2 completed
- walk.txt: lesson exercise completed
- carcost.txt: the car algorithm file
- mymain.cpp: The main file
- README.txt: Meta information about the homework files.
Hours on Breadboarding/Hardware: 1.5
Hours on Software With Partner: 5.5
Hours on Software Working Alone: 0.2
Hours Total: 7.2
Extra Credit:
- Completed program following pair-programming guidelines

(Add other information after the above as needed)
  • README.txt file name: The name of the README.txt file must be README.txt, or README*.txt where the * represents any set of valid file-name characters. Points may be deducted from your assignment score if you use a wrong file name.
  • Name: Put your name on the first line of the file. Points may be deducted from your assignment score if you use the wrong name.
  • Email: Your preferred email contact address.
  • Programming Partner: Your partner for the programming problem, which starts with assignment 3. Please do NOT record partner names for in-class exercises in the README.txt file.
  • OS: Operating system of the computer you work on, such as Windows Mac OS X, Linux, etc..
  • Asn#: The number of the assignment.
  • Status: Completed if the assignment is done. Otherwise, describe the current state of the assignment. Claiming you are done when you are not, or not accurately describing the status, may reduce your score even further.
  • Files: Name of each file followed by a brief description.
  • Hours spent: Record the estimated hours you spent on the homework assignment (not the work you do in class). Use decimal numbers only, such as 6.5. Do not use minutes or fractions such as 1/2. Label the hours as shown and put the estimated hours on the same line as the label. Include all three entries for hours, even if you do not work with a partner.
  • Extra credit: Describe any extra credit you attempted for the assignment. In addition, label the extra credit as shown in the example above. Failure to follow these instructions may reduce the number of any extra-credit points you receive.
  • Other information: If the assignment asks for other information to be included in your README.txt file, then label it clearly and place it after the other information.

Note to Mac Users: You can use TextEdit to save your README.txt file. However, you need to set up TextEdit to save files using plain text and not RTF. You will not get full credit unless you use plain text. For instructions on setting TextEdit to use plain text, see: Mac OS X: How to Set Up TextEdit as an HTML or Plain Text Editor.

Archive Your Files (Optional)

To make it easier to work with multiple files and directories, you may zip (archive) your files. Archiving is usually an optional step for an assignment. Archiving your files means to create a file containing one or more files in a compressed format. Most operating systems include an achiving (ZIP) tool. Also, you can get a third-party tool such as 7-zip.

When submitting files for grading in an archived format, you need to include all your files, including README.txt, in the archive. The archive type must be ZIP and the archived file must end in a .zip extension and contain only letters and numbers. Do NOT use special characters like spaces, #, : or $ in the name of the zip file or any folder or file name. Also, do not put zip files inside of zip files.

Here are instructions for zipping files on various operating systems:

Submit Your Files to Canvas

Submit the files using Canvas. After logging in to Canvas, click the Assignments link and then click the link for the correct assignment number. To upload files, you click the Submit Assignments button, choose File Upload, then click the Add Another File button to add each file for that assignment.

Do not submit Word or Excel documents unless specifically allowed in the assignment instructions. Failure to follow this requirement will result in a lower grade.

In Case of Difficulty

If Canvas is not available, or you are having trouble submitting, then contact the instructor for assistance. If the hour is late and your assignment is due early the next day, then email the instructor with a description of the problem and attach your assignment, with a copy to yourself. Also, bring your assignment to class in digital form so you can try to upload before class.

You will get a 0 unless unless you submit your assignment using Canvas. The instructor will work with you to get your assignment submitted correctly. However, the final responsibility for submitting assignments to Canvas on time rests with the student. Please plan ahead in case of difficulties.

See "Guides: How do I submit an online assignment?" for more information.