Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juknum/utbm-internship-report
UTBM Internship Report template in LaTeX
https://github.com/juknum/utbm-internship-report
covers internship latex report st40 st50 stage template utbm
Last synced: 4 months ago
JSON representation
UTBM Internship Report template in LaTeX
- Host: GitHub
- URL: https://github.com/juknum/utbm-internship-report
- Owner: Juknum
- License: mit
- Created: 2022-10-20T22:48:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T17:43:45.000Z (8 months ago)
- Last Synced: 2024-06-07T17:38:09.677Z (8 months ago)
- Topics: covers, internship, latex, report, st40, st50, stage, template, utbm
- Language: TeX
- Homepage:
- Size: 7.34 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
UTBM Internship Report Template in $LaTeX$
This repository serves as a template for internship reports at UTBM. It is built upon the UTBM internship LaTeX version and has been updated, adapted and expanded with multiple functionalities.
> [!IMPORTANT]
> This template is free to use, but the covers belongs to [UTBM](https://www.utbm.fr/) 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](https://www.utbm.fr/) in France, other countries, or both.
## I. Support
This template can be used in several places:
- Online with [Overleaf](https://www.overleaf.com) or GitHub Codespaces
- Locally on Windows/MacOS/Linux
## II. Features
### UTBM's Covers
You can find all configurable options for the covers with the commands below. If you want more freedom, you can still edit the covers by modifying [this file](https://github.com/Juknum/UTBM-Internship-Report/blob/main/libs/utbmcovers.sty).
https://github.com/Juknum/UTBM-Internship-Report/blob/70ee78176a0e31da98b336f6d7f1e5ad61432a8b/main.tex#L40-L56
You can also modify their colors using these variables:
https://github.com/Juknum/UTBM-Internship-Report/blob/70ee78176a0e31da98b336f6d7f1e5ad61432a8b/libs/utbmcovers.sty#L34-L51
Finally you can call both covers using:
```tex
\makeutbmfrontcover{} % Front cover
\makeutbmbackcover{} % & Back cover
```
Covers support English and French languages, you can change the language using the `babel` package:
```tex
\usepackage[english]{babel} % English
\usepackage[french]{babel} % French
```
---
## III. Usage
### Online
Overleaf
1. There are two ways to import this template on [Overleaf](https://www.overleaf.com/):
- 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 but you don't have git anymore)
2. 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.
GitHub Codespaces
1. Use this repository as a template:
- by clicking on the `Use this template` button ([see how here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template))
- by clicking [here](https://github.com/new?template_name=UTBM-Internship-Report).
2. Once you have your own repository, open it as a GitHub Codespaces and wait for it to fully build.
3. Install the recommended VSCode extension to be able to compile your files with [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)
4. Run the following command to get full git access:
```bash
git config --global --add safe.directory /workspace
```
### Locally
> [!NOTE]
> - You will need a $LaTeX$ distribution to compile this project locally.
> - You will need an IDE to edit and compile your $LaTeX$ files.
> - You may use this repository as a template by clicking on the `Use this template` button ([see how here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)) or [using this link](https://github.com/new?template_name=UTBM-Internship-Report).
#### Part A: LaTeX distribution
MiKTeX
[Website](https://miktex.org/download) — [Download](https://miktex.org/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 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
2. Install Perl using **Strawberry Perl**, available [here](http://strawberryperl.com/). 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.
3. Verify that both Perl and MiKTeX are in your `PATH` and restart any open command prompts.
4. You should now be able to compile your LaTeX files using MiKTeX.
###### On MacOS
2. Install Perl using **Homebrew**, available [here](https://brew.sh/).
```bash
brew install perl
```
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.
3. Add `~/bin` to your `PATH` by including the following line in your `~/.zshrc` file:
```bash
export PATH="/Users//bin:$PATH"
```
4. You should now be able to compile your $LaTeX$ files using MiKTeX.
> [!WARNING]
> In 3rd step we use the full path instead of `~/bin` or `$HOME/bin` as the `~` and `$HOME` variables do not work in combination with the VS Code `latex-workshop` extension.
TexLive
[Website](https://tug.org/texlive/)
For more in-depth information, take a look at the [documentation](https://tug.org/texlive/doc.html).
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](https://tug.org/texlive/acquire-netinstall.html), download `install-tl-windows.exe`, and install the distribution just like any other program.
###### On MacOS (MacTeX)
> [!NOTE]
> 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](https://tug.org/mactex/). Do not hesitate to make a PR if you have any information to add.
---
#### Part B: IDE
Visual Studio Code
[Website](https://code.visualstudio.com)
This template **requires** the use of the [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) extension to compile the LaTeX files directly within VS Code.
While not mandatory, the following extensions are recommended for some Quality of Life improvements:
- 🔸 [LaTeX Utilities](https://marketplace.visualstudio.com/items?itemName=tecosaur.latex-utilities) - Useful extension to extend the capabilities of LaTeX Workshop.
- 🪄 [LaTeX Formatter](https://marketplace.visualstudio.com/items?itemName=nickfode.latex-formatter) - Enhance the code base for a more user-friendly experience.
- 🔦 [LaTeX language support](https://marketplace.visualstudio.com/items?itemName=torn4dom4n.latex-support) - This extension adds syntax highlighting for LaTeX files.
- 📗 [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - Don't let typos slip through the cracks.
To compile the report, you can use the Ctrl + Alt + B shortcut or the `LaTeX Workshop: Build LaTeX project` command inside Visual Studio Code.
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`.
> [!NOTE]
> More information on the LaTeX Workshop extension can be found [here](https://github.com/James-Yu/LaTeX-Workshop/wiki/Install).
---
If you want to contribute to this project, feel free to make a PR 🤍