Template for your README. Remove all unused parts and instructions
Authors (team): AUTHORS WITH GITHUB LINKS
Variant: VARIANT SHOULD BE HERE
LIST LIBRARIES/TOOLS/OTHER UTILITIES THAT NEED TO BE INSTALLED (E.G. GCC, OPENMP, CMAKE ETC)
HOW TO COMPILE YOUR PROGRAM? (RECOMMENDED: ./compile.sh -- use ./compile.sh -h for info)
DESCRIBE THE INSTALLATION PROCESS (USE ./dependencies FOLDER)
Note: For Python scripts, You must add requirements.txt
file and add your env to the .gitignore file!
PROVIDE AN EXAMPLE OF HOW TO RUN YOUR PROGRAM (IT CAN BE A_flag COMMAND LINE WITH INPUT AND EXPECTED OUTPUT)
Note: if your project needs or generates any data, media and so on -- put them into the data folder
WHAT ELSE SHOULD WE KNOW ABOUT YOUR WORK? (E.G. KNOWN ISSUES, BUGS, SPECIAL BEHAVIOR ETC)
DESCRIBE THE RESULTS OF THE WORK YOU DID. WHAT DID YOU LEARN OR FIND INTERESTING?
IF APPLICABLE, LIST ALL THE EXTRA FEATURES YOU ADDED. PROVIDE DETAILS
Additional tasks not listed in the previous paragraph would not be graded.
Be sure to provide a complete list of authors.