Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
INSTALL.txt 1.18 KiB
The INSTALL.txt file should contain all information needed to install and run your code, from scratch, on a lab machine, including:
- Pre-conditions
  - Hardware, peripherals, and operating system restrictions for running your code ( i.e., can this code only run on lab machines, or can it run elsewhere?)
    - All code should run on our lab computers, unless you have an exemption from the instructor.
    - If some of your features work more efficiently on specific hardware, please explain this here.

- Supporting files
  - A list of non-standard libraries needed for your project to run, including:
    - Clear and simple instructions for how to freely (and legally!) acquire and install them from source code with minimal effort.
    - You may additionally link to a binary version of the libraries, if you wish.
  - Examples of how to use your project
    - Several clear examples the illustrate the main features of your project.
  - Descriptions of testing patterns, and instructions on how to exercise them:
    - unit tests
    - system tests
    
- Execution
  - Clear and terse instructions on how an average student in the class can compile and run all your code, from scratch, on a lab machine.