Project Report

This repository contains the LaTeX source files for the project report associated with Project Repository, which holds the main code and related materials. The report repository will be included as a submodule in the main project repository to facilitate a seamless integration of documentation alongside the project.

Structure

The repository is organized as follows:

• sections/: contains separate LaTeX files for each section of the report.
• images/: stores all images and diagrams included in the report.
• bibliography/: holds references and bibliography files.
• main.tex: the main LaTeX file that compiles the entire report.
• appendix-main.tex: the LaTeX file that compiles the appendix.
• compile.sh: a script to compile the report and appendix, or clean the build environment.

Authors

Name	GitHub	LinkedIn
Andrea Botticella
Elia Innocenti
Renato Mignone
Simone Romano

Compilation Instructions

To compile the report or clean the output directory, you can use the provided compile.sh script.

First Time Setup

Before using the compile.sh script for the first time, make sure it has the necessary execute permissions. Run the following command to grant execute permissions to the script:

chmod +x compile.sh

Compile Options

The compile.sh script provides the following functionalities:

• Compile both main report and appendix:

  ./compile.sh

  This is the default behavior and compiles both main.tex and appendix-main.tex, generating PDFs for the report and appendix in the out directory.

• Compile only the main report:

  ./compile.sh main

  This compiles main.tex and generates the report PDF.

• Compile only the appendix:

  ./compile.sh appendix

  This compiles appendix-main.tex and generates the appendix PDF.

• Clean the output directory:

  ./compile.sh clean

  This removes all files in the out directory and any previously generated PDFs in the project root, ensuring a fresh build environment.

For any issues, please refer to the main project repository or contact the authors.

Notes

• Ensure all necessary dependencies, including LaTeX and bibliography tools, are installed on your system before running the script.
• The output files are saved in the out directory, with the report and appendix PDFs copied to the project root with custom names.

---

This repository is structured for ease of integration and version control, with the report versioned separately from the main codebase. Happy compiling!