This repository serves as a template for internship reports at UTBM. It is built upon the UTBM internship LaTeX version and has been adapted and expanded with multiple functionalities.
You can find all configurable options for UTBM covers in the code below. If you're unsatisfied, you still have the option to edit the covers using this file.
\makeutbmfrontcover{} % Front cover\makeutbmbackcover{} % & Back cover
Covers support English and French languages, you can change the language using the babel package:
\usepackage[english]{babel} % English\usepackage[french]{babel} % French
III. Usage
There are multiple ways to use this template; you can either use it online or locally:
Online
Overleaf
There are two ways to import this template on Overleaf:
You can either use the "Import from GitHub" button and paste the link of this repository. (This method requires a paid plan)
Alternatively, you can download the repository as a zip file and upload it on Overleaf. (This method is free)
The last step is to change the compiler from pdfLaTeX to XeLaTeX. You can do this by clicking on the Menu button and finding it in the Settings category.
Any other online LaTeX editors to suggest?
Locally
Clone this repository using the following command:
Easy to install but does not ship with Perl, which the latexmk package requires.
Install MiKTeX using the above link. Then, you have the option to upgrade your installation to a standard TeX system by clicking the Upgrade button. Please be aware that this initiates a ~200MB download.
Alternatively, you can enable the auto-install feature and let MiKTeX install missing packages on-the-fly. You can find this option in the Settings tab.
On Windows
Install Perl using Strawberry Perl, available here. Once installed, verify that Perl is available by opening a new command prompt and typing perl -v. If installed correctly, you should see the version of Perl that you installed.
Verify that both Perl and MiKTeX are in your PATH and restart any open command prompts.
You should now be able to compile your $LaTeX$ files using MiKTeX.
Once installed, verify that Perl is available by opening a new terminal and typing perl -v. If installed correctly, you should see the version of Perl that you installed.
Add ~/bin to your PATH by including the following line in your ~/.zshrc file:
export PATH="/Users/<username>/bin:$PATH"
[!WARNING]
Here, we use the full path instead of ~/bin or $HOME/bin because the ~ and $HOME variables do not work in combination with the VS Code latex-workshop extension.
You should now be able to compile your $LaTeX$ files using MiKTeX.
For more in-depth information, take a look at the documentation.
TeX is a really popular distribution. Despite the installation process being quite lengthy, it enables the direct use and compilation of a project using this repository in VSCode, as explained later.
On Windows
Follow the link, download install-tl-windows.exe, and install the distribution just like any other program.
On MacOS (MacTeX)
Warning
The name is different, but it is developed by the same team of programmers. It has not been tested whether the operating conditions are identical to those on Windows. Let us know if you are in this situation.
An installation and usage guide is available here. Do not hesitate to make a PR if you have any information to add.
Any other LaTeX distribution to suggest?
Part B: IDE
After installing a LaTeX distribution, you will need an IDE to edit and compile your $LaTeX$ files. Here is a list of tested and working IDEs for this project:
To compile the report, you can use the Ctrl + Alt + B shortcut or the LaTeX Workshop: Build LaTeX project command inside Visual Studio Code.
[!NOTE]
More information on the LaTeX Workshop extension can be found here.
You can open and use this project by opening the folder in the source control menu (on the left-hand side of the interface) and using this link: https://github.com/Juknum/UTBM-Internship-Report.git.
Any other IDE to suggest?
If you want to contribute to this project, feel free to make a PR 🤍
About
UTBM's Internship Report template written in LaTeX