What to include with the solutions?
General requirements
- Package the solution as a zip file. Tar.gz, tar.bz2 are also suitable, if the previous ones are not available, then rar.
- Upload the solution to courses. Solutions by email are not accepted. The link is in the menu on the left.
- Submit on time
- The tasks are not overly complicated. Make your own solution. You can ask for help, but don't take another student's code.
- If you use code from an internet source, you must add a reference to the source to the code file.
Your solution should have
- Source code (*.c/*.cpp files (depending on whether the program is in C or C++). C programs must have a .c extension and C++ programs must have a .cpp extension.
- Headers (*.h files)
- Makefile
- Doxyfile (Doxygen configuration file for generating documentation)
Do not include
- Compiled program (.exe)
- Object files (.o)
- External libraries (.a, .so, .dylib, .dll)
- Generated Doxygen comments (html/latex/etc folders)
- Unrelated files.
When checking homework, we will:
- Unzip the ZIP archive.
- Run make
- Run doxygen
- We test the programs with prepared test scripts, which means that the output of the program must be the same as described in the task
- We will read the source code in case of issues or doubt
After compiling, we expect to have in a visible location:
- The executable program (the file with the name specified in the task)
- Documentation (we will check for the html form). Functions, parameters, possible return values, classes, and other named symbols must be documented.