Skip to content

Latest commit

 

History

History
233 lines (172 loc) · 8.64 KB

README.md

File metadata and controls

233 lines (172 loc) · 8.64 KB
Raw

UTBM — Internship Report Template

GitHub GitHub last commit

This repository is a template for internship reports at the UTBM. It is based on the UTBM internship LaTeX version and has been adapted and expanded with multiple functionalities.

Table of contents

I. Support

This template can be used in several places:

  • Online with Overleaf
  • Locally on Windows/MacOS/Linux

II. Features

Warning
This template is free to use, but the covers belongs to the UTBM and can only be used with their authorization.

Note
UTBM and all UTBM-related trademarks and logos are trademarks or registered trademarks of the University of Technology of Belfort-Montbéliard in France, other countries, or both.

UTBM's Covers

You can find all configurable options of UTBM covers within the below code, but if you feel unhappy you can still edit the covers with this file here.

https://github.com/Juknum/UTBM-Internship-Report/blob/108d23dee1516941a37bd0aa2fcbf109c8e18f6c/main.tex#L32-L55

You can also modify their colors using those variables:

https://github.com/Juknum/UTBM-Internship-Report/blob/108d23dee1516941a37bd0aa2fcbf109c8e18f6c/libs/utbmcovers.sty#L36-L55

Finally you can call both covers using:

\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 is multiple way to use this template, you can either use it online or locally:

Online

Overleaf

  1. There is two way to import this template on Overleaf:

    • You can either use the "import from GitHub" button, and then paste the link of this repository. (You will need the paid plan to use this method)
    • Or you can download the repository as a zip file and upload it on Overleaf. (You can use this method for free)

  2. The last step is to change the compiler from pdfLaTeX to XeLaTeX, you can do it by clicking on the Menu button and then you can find it in the Settings category.

Any other online LaTeX editors to suggest?

Locally

Clone this repository using the following command:

git clone 'https://github.com/Juknum/UTBM-Internship-Report/tree/main'

Note
You may also want to use this repository as a template, you can do it by clicking on the Use this template button or by clicking here.

Part A: LaTeX distribution

You will need a LaTeX distribution to compile this project locally, here is a list of tested and working distributions for this project:

MiKTeX
Website — Download

Easy to install but does not ship with Perl which the latexmk package requires.

  1. Install MiKTeX using the above link. Then you have the option to upgrade your installation to a standard TeX system. Just click the Upgrade button. Please be aware that this starts a ~200MB download.
    Alternatively, you can turn on the auto-install feature and let MiKTeX install missing packages on-the-fly. You can find this option in the Settings tab.
On Windows

  1. You can install Perl using Strawberry Perl, which is available here.
    Once it's installed, you can verify that Perl is available by opening a new command prompt and typing perl -v. If it's installed correctly, you should see the version of Perl that you installed.

  2. Verify that both Perl and MiKTeX are in your PATH and restart any open command prompts.

  3. You should now be able to compile your $LaTeX$ files using MiKTeX.

On MacOS

  1. You can install Perl using Homebrew, which is available here.

    brew install perl

    Once it's installed, you can verify that Perl is available by opening a new terminal and typing perl -v. If it's installed correctly, you should see the version of Perl that you installed.

  2. Add ~/bin to your PATH by adding the following line to your ~/.zshrc file:

    export PATH="/Users/<username>/bin:$PATH"

    Warning
    Here we use the full path instead of using ~/bin or $HOME/bin because the ~ and $HOME variables does not works if used in combination with the VS Code latex-workshop extension.

  3. You should now be able to compile your $LaTeX$ files using MiKTeX.

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:

Visual Studio Code
Website

This template require the use of the LaTeX Workshop extension to compile the $LaTeX$ files directly within VS Code.

While they are not required to use the template, the following extensions are recommended for some Quality of Life improvements:

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.

Any other IDE to suggest?

If you want to contribute to this project, feel free to make a PR 🤍