- The course name and number (in the subject line of the email)
|
- Your name and the names of your group members if it's a group
submission (include this information in the body of the email and in the
README file).
|
- The name of the project (if it's one of the standard ones listed on
Katrin Becker's 235 web page) or a brief description (if it's not one of
these projects).
|
- A list of the features that were actually implemented in your program
(functional requirements that were met) e.g., for battleship it would
include things like whether the game allows for two players or only allows
for a single board. You can simply put it in the form of a checklist
but make sure that you are specific and complete so I know what to look
for!
|
- An indication of whether this is the first time that you are
submitting the project for the first time or if you are re-submitting it
for additional marks. If it's a resubmission then briefly indicate
what you changed (so that Jim Parker doesn't have to look through the
whole program again from scratch).
|
- If you compress your submission then please use zip instead of tars.
It's not only the standard used to compress Java source code files but
utilities are readily available both on UNIX and in Windows. Also
make sure that you include all source code (".java") files.
|
- A README file. The target reader should be the person who is
just running your program (as opposed to another developer who be looking
at your source code) may include some or all of the following:
|
| |
- How to run your program (at the very least it should indicate which
class contains the 'main' method).
|
| |
- What data files are needed for your program to run and what is their
required location relative to the source code files (if applicable).
|
| |
- Are there additional libraries that your program needs to run aside
from the ones built in JDK (e.g., tio, curses etc.), if so include them
with your submission. Assume that I don't have any of these
libraries available on my computer and need you to send them to me in
order to get your program running,
|
| |
- What version of the JDK that you used to create your code (include
this point only if your program works for certain versions but typically
you should try not to write code that extremely version dependent).
|