COMS 1001: Introduction to Computers                             Spring 2006
How To Submit Homework
$Id: submission-HOWTO.txt,v 1.3 2006/01/17 00:17:08 locasto Exp $
----------------------------------------------------------------------------

[Summary]

 Homeworks should be submitted to the appropriate folder in Courseworks as
 a single zip or tar.gz file that conforms to the specifications described 
 in this document. Homework submissions that do not conform to this 
 standard will not be graded. If you make multiple submissions, only the 
 last one before the deadline will count.

 Please name your submission according to the following format:
  
   hwX-UNI.zip
 
 where 'X' is the number of the homework (1,2,3, or 4) and 'UNI' is replaced
 with your Columbia ID. For example, my submission for homework 1 would be:

   hw1-mel2008.zip

 and would contain all the relevant homework files.

 An example of creating this file (on Unix) is below.

[Components]

 A homework submission should contain a directory with the following items:

  - a file named 'README' produced with a text editor (i.e., NOT MSWord) 
    that: 
      a) lists the name and CUID of the student and anyone the
         student worked with
      b) explains how the submission satisfied the requirements of the 
         homework -- in particular whether or not all problems were solved
         and to what degree.
      c) lists what sources, if any, the student used to produce the code
         that solves the homework problems
      d) answers any written parts of the homework
      e) contains a list of source files and which homework subproblem 
         they address

  - any reasonable number of Bash or Javascript/HTML source files 
    that contain the source code for your solutions. The files should
    be appropriately named so that the grader can distinguish which
    source files correspond to which homework subproblem. 

 ...and that's it. Do not include any binaries, object files, extra
 documentation, messages, backup files, assembly language files, 
 non-essential web pages, core dumps, etc.

 To summarize, the only things that belong in your submission are a
 README file and your source code.

[What Are These Components?]

 The README is explained above, but it's basically the documentation
 explaining to the TA how you have completed the assignment.

 Your source code is simply the collection of Bash scripts or Javascript
 functions and HTML pages that provide a solution to the homework problems.

[How Homeworks Are Evaluated]

 Homeworks are downloaded, unzipped, and run against a test suite by the 
 TA. It is to your advantage to accomplish small tasks completely in the 
 homework (and explain this in your README) if you are unable to finish the
 whole problem. It is better to be graded on a single working sub-part than
 a broken whole.

 The test suite will exercise your program to make sure you solved all
 parts of the problem. Your programs will be evaluated partly based on
 the output they produce under this test suite.

[Example Submission]

NOTE: The following statements form an example Bash session illustrating
how to create a zip file on Unix. You can basically do the same thing
from Windows by using your favorite Zip application (WinZip, WinRAR, etc.),
selecting the files you want to submit, right clicking, and saying 'add to
zipfile'

$ cd ~
$ cd coms1001/code
$ ls
hw1/    hw2/   hw3/   hw4/
$ cd hw1/
$ ls
helloworld.html   hi.js   README
$ cd ..
$ zip -rv hw1-mel2008.zip hw1/
$ ls
hw1/  hw1-mel2008.zip  hw2/   hw3/   hw4/
$

Now you can scp or sftp this file from the CUNIX machines to your local 
host and upload it to Courseworks from there.