Project Structure
-
folder structure As we use Rust, the structure per specification does not go well together with the cargo defaults (for docs, 3rd party code,...) and thus we won't use the C boilerplate structure. -
c boilerplate clean up -
remove lex/bison branch -
update readme (@csav4759): as specified in https://git.uibk.ac.at/c7031162/703602-Compiler-Construction/blob/master/evaluation_scheme.md -
@free4all add to known issues in readme.md on refactoring2 branch
Known Issues
At any point in time, the README contains a list of unfixed, known issues.
Each entry is kept short and concise including a justification. Complex issues may reference a dedicated document inside docs
elaborating it in greater detail.
Testing
Crucial or complicated logic should be tested adequately.
The project infrastructure provides a simple way to run all unit and integration tests. See the getting started code-base for example.
Similarly, a way to run unit tests using valgrind
is provided.
Dependencies
The prerequisites section of the README enumerates all dependencies. The implementation should not have any dependencies apart from the standard library, system libraries, a testing framework, and a lexer / parser generator.
If a dependency is not available via the evaluation system's package manager, it needs to be automatically built and used by the build system. It is recommended to vendor such dependencies rather than downloading them during build time.