Innovations in Visualization

CPSC 583: Guidelines for README files

The README file helps us to understand and run your code. It is in your best interest to make it clear, concise, and informative.

  • Call it firstname.lastname.README.txt (or PDF)
  • This is a separate file from your project report

Include information about:

  • How to set up the project and compile the code
  • How to run the code (including whether it is an applet or an application)
  • The basic structure of the code (what is the main class, what are the important classes, how do they fit together)
  • Libraries and code reuse
    • Which part of the library/sample code was used
    • What features it was used for
    • How you modified it (in general)
  • How to interact with the program + major features