Project-2/README.md

Project 2

Practical information

• Project

Compile and run C++ programs

Compiling and linking is done using Make, make sure you are in the root directory.

There are two ways of compiling the code. The first alternative is to change directory to src/ and compile

    cd src && make

The second alternative does not involve changing directory to src/, use make in the projects root directory

    make code

You can run any of the compiled programs by changing directory to src/, then

    ./test_suite
    ./main

Generate plots

To generate plots, you can do

python3 plot.py

and the plots will be saved inside latex/images.

Generate documentation

For this project, we have used Doxygen to generate some nice and readable documentation for the C++ code.

If you want to generate the documentation you can do

    make docs

in the project root, and the documentation will be made into the docs/ directory.

Generate project document

If you want to recompile the Pdf file, you can do

    make latex

and a Pdf file will be produced inside the latex/ directory.