Submitting a project

From Inforail
Jump to: navigation, search

General procedure

The standard UTM practice is to submit reports in paper form, however it is more convenient to keep them in an electronic archive on a file system (they can be easily retrieved, searched, copied; and they take no physical space)

Regardless of the form of the original report, an electronic version must be sent to me via email.
If you don't have access to the internet, you can pass me the files using other methods.


If the project does not compile, does not meet all the requirements, or has some known bugs - submit it anyway, but you must:

  • prove that you tried your best to make it work;
  • provide a semi-working prototype;
  • be able to explain which parts of the program work, which ones do not (and why they do not);
  • be able to provide an educated guess about what is wrong with it;
  • explain what must be done to solve the existing bugs.

In either case, it is better to submit a buggy project before the deadline than to submit a working one long after the deadline.

Deadlines

You must submit the projects before on time; otherwise they pile up and it becomes very difficult for you to handle the situation.

  • A project must be submitted before a new assignment is given, or on the same day;
  • Penalties will be applied if you fail to submit a project on time:
    • +2 weeks = -1 point from the grade

Contents

Each submitted project must include:

  • The source code;
    • Compilation instructions (if they are "exotic")
    • Instructions of use (if things are not self-explanatory)
  • Flowcharts and diagrams that explain what the code is doing;
  • The report.

Including the binary executable is not mandatory, but you should do so when your project requires non-standard libraries or depends on things which are most likely not present on someone else's computer.

Penalties

Here is an incomplete list of things you can do and get penalized:

  • Provide a binary executable which was obtained from source code other than the one you included;
  • Submit someone else's work.

Misc

  • If the report is too long (too many pages to print == size++, cost++), you can cut its size by removing the less important parts of the source code;
  • However, the electronic version of the report must contain everything.