{"id":17055033,"url":"https://github.com/juknum/utbm-internship-report","last_synced_at":"2025-04-12T17:09:45.954Z","repository":{"id":110330021,"uuid":"555073246","full_name":"Juknum/UTBM-Internship-Report","owner":"Juknum","description":"UTBM Internship Report template in LaTeX","archived":false,"fork":false,"pushed_at":"2024-06-06T17:43:45.000Z","size":7697,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-21T04:11:35.223Z","etag":null,"topics":["covers","internship","latex","report","st40","st50","stage","template","utbm"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Juknum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-10-20T22:48:23.000Z","updated_at":"2025-02-10T21:49:43.000Z","dependencies_parsed_at":"2023-11-09T15:39:47.187Z","dependency_job_id":null,"html_url":"https://github.com/Juknum/UTBM-Internship-Report","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juknum%2FUTBM-Internship-Report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juknum%2FUTBM-Internship-Report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juknum%2FUTBM-Internship-Report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Juknum%2FUTBM-Internship-Report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Juknum","download_url":"https://codeload.github.com/Juknum/UTBM-Internship-Report/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240075455,"owners_count":19744086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["covers","internship","latex","report","st40","st50","stage","template","utbm"],"created_at":"2024-10-14T10:16:31.721Z","updated_at":"2025-02-21T19:30:58.310Z","avatar_url":"https://github.com/Juknum.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003ch1\u003e\n\u003cpicture\u003e\n  \u003csource\n   srcset=\"https://github.com/Juknum/Juknum/assets/49886317/11f7f0ad-b50f-4a6b-8aec-422bacedd62e\"\n   media=\"(prefers-color-scheme: dark)\" /\u003e\n  \u003csource\n   srcset=\"https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/71a5ae6f-f7aa-465a-a1a6-83975aa35adc\"\n   media=\"(prefers-color-scheme: light), (prefers-color-scheme: no-preference)\" /\u003e\n  \u003cimg height=\"24\" src=\"https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/71a5ae6f-f7aa-465a-a1a6-83975aa35adc\" /\u003e\n \u003c/picture\u003e\nUTBM Internship Report Template in $LaTeX$\n\u003c/h1\u003e\n\n\u003c!-- badges  --\u003e\n![GitHub](https://img.shields.io/github/license/Juknum/UTBM-Internship-Report?style=for-the-badge)\n![GitHub last commit](https://img.shields.io/github/last-commit/Juknum/UTBM-Internship-Report?style=for-the-badge)\n\n![pdf](https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/c502a51c-89bd-485c-b9d9-48a258273b6e)\n\n\u003cp align=\"center\"\u003e\n  This repository serves as a template for internship reports at UTBM. It is built upon the \u003ca href=\"https://github.com/pinam45/utbm-latex-internship-report-covers\"\u003eUTBM internship LaTeX version\u003c/a\u003e and has been updated, adapted and expanded with multiple functionalities.\n\u003c/p\u003e\n\n\u003e [!IMPORTANT]  \n\u003e This template is free to use, but the covers belongs to [UTBM](https://www.utbm.fr/) and can only be used with their authorization.  \n\n\u003e [!NOTE]  \n\u003e 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.\n\n## I. Support\n\nThis template can be used in several places:\n\n- Online with [Overleaf](https://www.overleaf.com) or GitHub Codespaces\n- Locally on Windows/MacOS/Linux\n\n## II. Features\n### UTBM's Covers\n\nYou 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).  \n\u003c!-- Code block mention (GitHub markdown feature) --\u003e\n\nhttps://github.com/Juknum/UTBM-Internship-Report/blob/70ee78176a0e31da98b336f6d7f1e5ad61432a8b/main.tex#L40-L56  \n\nYou can also modify their colors using these variables:  \n\u003c!-- Code block mention (GitHub markdown feature) --\u003e\n\nhttps://github.com/Juknum/UTBM-Internship-Report/blob/70ee78176a0e31da98b336f6d7f1e5ad61432a8b/libs/utbmcovers.sty#L34-L51  \n\nFinally you can call both covers using:\n\n```tex\n\\makeutbmfrontcover{} % Front cover\n\\makeutbmbackcover{}  % \u0026 Back cover\n```\n\nCovers support English and French languages, you can change the language using the `babel` package:\n\n```tex\n\\usepackage[english]{babel} % English\n\\usepackage[french]{babel}  % French\n```\n\n---\n\n## III. Usage\n### Online\n\n\u003ch4\u003e\n  \u003cimg src=\"https://cdn.overleaf.com/img/ol-brand/overleaf_og_logo.png\" height=\"12\"\u003e\n  Overleaf\n\u003c/h4\u003e\n\n1. There are two ways to import this template on [Overleaf](https://www.overleaf.com/):\n    - You can either use the `Import from GitHub` button and paste the link of this repository. (This method requires a paid plan)\n    - 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)\n\n2. 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.\n\n\u003ch4\u003e\n  \u003cpicture\u003e\n    \u003csource\n    srcset=\"https://github.githubassets.com/favicons/favicon-dark.png\"\n    media=\"(prefers-color-scheme: dark)\" /\u003e\n    \u003csource\n    srcset=\"https://github.githubassets.com/favicons/favicon.png\"\n    media=\"(prefers-color-scheme: light), (prefers-color-scheme: no-preference)\" /\u003e\n    \u003cimg height=\"12\" src=\"https://github.githubassets.com/favicons/favicon.png\" /\u003e\n  \u003c/picture\u003e\n  GitHub Codespaces\n\u003c/h4\u003e\n\n1. Use this repository as a template:\n    - 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))\n    - by clicking [here](https://github.com/new?template_name=UTBM-Internship-Report).\n      \n2. Once you have your own repository, open it as a GitHub Codespaces and wait for it to fully build.\n3. 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)\n4. Run the following command to get full git access:\n    ```bash\n      git config --global --add safe.directory /workspace\n    ```\n\n### Locally\n\n\u003e [!NOTE]  \n\u003e - You will need a $LaTeX$ distribution to compile this project locally.\n\u003e - You will need an IDE to edit and compile your $LaTeX$ files.\n\u003e - 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).\n\n#### Part A: LaTeX distribution\n\n\u003ch5\u003e\n  \u003cimg src=\"https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/2162967b-c3ff-4c70-94cd-ce5a31156814\"  height=\"12\"\u003e\n  MiKTeX\n\u003c/h5\u003e\n\n[Website](https://miktex.org/download) — [Download](https://miktex.org/download)\n  \nEasy to install \u003cu\u003ebut does not ship with Perl, which the `latexmk` package requires.\u003c/u\u003e\n\n1. 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.\n_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._\n\n###### On Windows\n\n2. 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.\n\n3. Verify that both Perl and MiKTeX are in your `PATH` and restart any open command prompts.\n\n4. You should now be able to compile your LaTeX files using MiKTeX.\n\n###### On MacOS\n\n2. Install Perl using **Homebrew**, available [here](https://brew.sh/).\n\n    ```bash\n    brew install perl\n    ```\n\n    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.\n\n3. Add `~/bin` to your `PATH` by including the following line in your `~/.zshrc` file:\n\n    ```bash\n    export PATH=\"/Users/\u003cusername\u003e/bin:$PATH\"\n    ```\n\n4. You should now be able to compile your $LaTeX$ files using MiKTeX.\n\n\u003e [!WARNING]  \n\u003e 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.\n\n\u003ch5\u003e\n  \u003cimg src=\"https://ctan.org/teaser/pkg/texlive\"  height=\"12\"\u003e\n  TexLive\n\u003c/h5\u003e\n\n[Website](https://tug.org/texlive/)\n\nFor more in-depth information, take a look at the [documentation](https://tug.org/texlive/doc.html).\n\nTeX 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.\n\n###### On Windows\n\nFollow the [link](https://tug.org/texlive/acquire-netinstall.html), download `install-tl-windows.exe`, and install the distribution just like any other program.\n\n###### On MacOS (MacTeX)\n\n\u003e [!NOTE]  \n\u003e 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.\n\nAn 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.\n\n---\n\n#### Part B: IDE\n\n\u003ch5\u003e\n  \u003cimg src=\"https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/dba03968-0b1a-4812-a82d-742ffc8c31a8\"  height=\"12\"\u003e\n  Visual Studio Code\n\u003c/h5\u003e\n\n[Website](https://code.visualstudio.com)\n  \nThis 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.\n\nWhile not mandatory, the following extensions are recommended for some Quality of Life improvements:\n\n- 🔸 [LaTeX Utilities](https://marketplace.visualstudio.com/items?itemName=tecosaur.latex-utilities) - Useful extension to extend the capabilities of LaTeX Workshop.\n- 🪄 [LaTeX Formatter](https://marketplace.visualstudio.com/items?itemName=nickfode.latex-formatter) - Enhance the code base for a more user-friendly experience.\n- 🔦 [LaTeX language support](https://marketplace.visualstudio.com/items?itemName=torn4dom4n.latex-support) - This extension adds syntax highlighting for LaTeX files.\n- 📗 [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - Don't let typos slip through the cracks.\n\nTo compile the report, you can use the \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eAlt\u003c/kbd\u003e + \u003ckbd\u003eB\u003c/kbd\u003e shortcut or the `LaTeX Workshop: Build LaTeX project` command inside Visual Studio Code.\n\nYou 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`.\n\n\u003e [!NOTE]  \n\u003e More information on the LaTeX Workshop extension can be found [here](https://github.com/James-Yu/LaTeX-Workshop/wiki/Install).\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eIf you want to contribute to this project, feel free to make a PR 🤍\u003c/i\u003e\n\u003c/p\u003e \n\n\n\u003c!--\n\n### Online\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003e\n      Overleaf\n    \u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n\n1. There are two ways to import this template on [Overleaf](https://www.overleaf.com/):\n    - You can either use the \"Import from GitHub\" button and paste the link of this repository. (This method requires a paid plan)\n    - Alternatively, you can download the repository as a zip file and upload it on Overleaf. (This method is free)\n\n2. 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.\n\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003e\n      \n      GitHub Codespaces\n    \u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n\n1. Use this repository as a template by clicking on the `Use this template` button or by clicking [here](https://github.com/new?template_name=UTBM-Internship-Report\u0026template_owner=Juknum).\n2. Once you have your own repository, open it as a GitHub Codespaces and wait for it to fully build.\n3. 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)\n4. Run the following command to get full git access:\n\n  ```bash\n    git config --global --add safe.directory /workspace\n  ```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cp align=\"center\"\u003e\u003ci\u003eAny other online LaTeX editors to suggest?\u003c/i\u003e\u003cp\u003e\n\n### Locally\n\nUse this repository as a template by clicking on the `Use this template` button or by clicking [here](https://github.com/new?template_name=UTBM-Internship-Report\u0026template_owner=Juknum).\n\n#### Part A: LaTeX distribution\n\nYou will need a LaTeX distribution to compile this project locally. Here is a list of tested and working distributions for this project:\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e\n  \n  MiKTeX\n\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\u003ca href=\"https://miktex.org/download\"\u003eWebsite\u003c/a\u003e — \u003ca href=\"https://miktex.org/download\"\u003eDownload\u003c/a\u003e\n\nEasy to install \u003cu\u003ebut does not ship with Perl, which the `latexmk` package requires.\u003c/u\u003e\n\n1. 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.\n_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._\n\n\u003ch5\u003eOn Windows\u003c/h5\u003e \n\n2. 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.\n\n3. Verify that both Perl and MiKTeX are in your `PATH` and restart any open command prompts.\n\n4. You should now be able to compile your $LaTeX$ files using MiKTeX.\n\n\u003ch5\u003eOn MacOS\u003c/h5\u003e\n\n2. Install Perl using **Homebrew**, available [here](https://brew.sh/).\n\n    ```bash\n    brew install perl\n    ```\n\n    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.\n\n3. Add `~/bin` to your `PATH` by including the following line in your `~/.zshrc` file:\n\n    ```bash\n    export PATH=\"/Users/\u003cusername\u003e/bin:$PATH\"\n    ```\n\n    \u003e [!WARNING]  \n    \u003e 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.\n\n4. You should now be able to compile your $LaTeX$ files using MiKTeX.\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003cth\u003e\n  \u003cimg src=\"https://ctan.org/teaser/pkg/texlive\"  height=\"16\" style=\"margin: 0 6px -2px 0;\"\u003e\n  TexLive\n\u003c/th\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\u003ca href=\"https://tug.org/texlive/\"\u003eWebsite\u003c/a\u003e\n\nFor more in-depth information, take a look at the [documentation](https://tug.org/texlive/doc.html).\n\nTeX 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.\n\n\u003ch5\u003eOn Windows\u003c/h5\u003e\n\nFollow the [link](https://tug.org/texlive/acquire-netinstall.html), download `install-tl-windows.exe`, and install the distribution just like any other program.\n\n\u003ch5\u003eOn MacOS (MacTeX)\u003c/h5\u003e\n\n\u003e [!WARNING]  \n\u003e 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.\n\nAn 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.\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\u003cp align=\"center\"\u003e\u003ci\u003eAny other LaTeX distribution to suggest?\u003c/i\u003e\u003c/p\u003e\n\n#### Part B: IDE\n\nAfter 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:\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003e\n      \u003cimg src=\"https://github.com/Juknum/UTBM-Internship-Report/assets/49886317/dba03968-0b1a-4812-a82d-742ffc8c31a8\"  height=\"16\" style=\"margin: 0 6px -2px 0;\"\u003e\n      Visual Studio Code\n    \u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n    \u003ca href=\"https://code.visualstudio.com\"\u003eWebsite\u003c/a\u003e\n      \nThis 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.\n\nWhile not mandatory, the following extensions are recommended for some Quality of Life improvements:\n\n- 🔸 [LaTeX Utilities](https://marketplace.visualstudio.com/items?itemName=tecosaur.latex-utilities) - Useful extension to extend the capabilities of LaTeX Workshop.\n- 🪄 [LaTeX Formatter](https://marketplace.visualstudio.com/items?itemName=nickfode.latex-formatter) - Enhance the code base for a more user-friendly experience.\n- 🔦 [LaTeX language support](https://marketplace.visualstudio.com/items?itemName=torn4dom4n.latex-support) - This extension adds syntax highlighting for LaTeX files.\n- 📗 [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - Don't let typos slip through the cracks.\n\nTo compile the report, you can use the \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eAlt\u003c/kbd\u003e + \u003ckbd\u003eB\u003c/kbd\u003e shortcut or the `LaTeX Workshop: Build LaTeX project` command inside Visual Studio Code.\n\n\u003e [!NOTE]  \n\u003e More information on the LaTeX Workshop extension can be found [here](https://github.com/James-Yu/LaTeX-Workshop/wiki/Install).\n\nYou 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`.\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cp align=\"center\"\u003e\u003ci\u003eAny other IDE to suggest?\u003c/i\u003e\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eIf you want to contribute to this project, feel free to make a PR 🤍\u003c/i\u003e\n\u003c/p\u003e \n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuknum%2Futbm-internship-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuknum%2Futbm-internship-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuknum%2Futbm-internship-report/lists"}