README.md

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

# Git Handbook
## Project Overview

Some useful explanations about [Git](https://git-scm.com/) written in French for now (could be translated if needed).

## Project Description

This project is written entirely in [Typst](https://typst.app/).

 You can use any IDE that supports Typst syntax highlighting and Typst LSP.

## Project Setup
### Prerequisites

On Fedora-based systems:
```shell
sudo dnf copr enable claaj/typst
sudo dnf install typst
```

On Arch-based systems:
```shell
sudo pacman -Sy typst
```

### Clone the Project Repository

Navigate to any folder you prefer and run the following commands:
```shell
git clone https://forge.univ-lyon1.fr/p2201423/git-handbook.git
cd git-handbook
```

The command above will clone all files from our repository onto your disk and place you in the correct working directory.

### Building the Project

Simply run the `build.sh` script to perform a fresh and clean build of our project, or execute the command `typst c main.typ`.

## Useful Tools

- [Typst Documentation](https://typst.app/docs/).

## References

If you are familiar with LaTeX and would like to help us, you can read the following article: [Guide for LaTeX Users](https://typst.app/docs/guides/guide-for-latex-users/).

## Attributions

The content of this handbook is attributed to the [Git Documentation](https://git-scm.com/docs).

The original gitlab pipeline as been created by [Iván Sánchez Ortega](https://gitlab.com/IvanSanchez) and is available [here](https://gitlab.com/IvanSanchez/gitlab-ci-typst).

<hr>

# Git Handbook
## Aperçu du Projet

Quelques explications utiles sur [Git](https://git-scm.com/) écrites en français pour l'instant (peuvent être traduites si nécessaire).

## Description du Projet

Ce projet est entièrement écrit en [Typst](https://typst.app/). 

Vous pouvez utiliser n'importe quel IDE qui prend en charge la coloration syntaxique Typst et Typst LSP.

## Configuration du Projet
### Prérequis

Sur les systèmes basés sur Fedora :
```shell
sudo dnf copr enable claaj/typst
sudo dnf install typst
```

Sur les systèmes basés sur Arch :
```shell
sudo pacman -Sy typst
```

### Cloner le dépôt du Projet

Naviguez vers le dossier de votre choix et exécutez les commandes suivantes :
```shell
git clone https://forge.univ-lyon1.fr/p2201423/git-handbook.git
cd git-handbook
```

La commande ci-dessus clonera tous les fichiers de notre dépôt sur votre disque et vous placera dans le bon répertoire de travail.

### Construction du Projet

Il suffit d'exécuter le script `build.sh` pour effectuer une _build_ frais et propre de notre projet, ou d'exécuter la commande `typst c main.typ`.

## Outils Utiles

- [Documentation Typst](https://typst.app/docs/).

## Références

Si vous êtes familier avec LaTeX et souhaitez nous aider, vous pouvez lire l'article suivant : [Guide pour les Utilisateurs de LaTeX](https://typst.app/docs/guides/guide-for-latex-users/).

## Attributions

Le contenu de ce livret est attribué à la [Documentation de Git](https://git-scm.com/docs).

La _pipeline_ gitlab originale a été créée par [Iván Sánchez Ortega](https://gitlab.com/IvanSanchez) et est disponible [ici](https://gitlab.com/IvanSanchez/gitlab-ci-typst).