# Le compte rendu de TP

A chaque TP, vous devrez rendre un compte-rendu. Ce compte-rendu permettra d'évaluer ce que vous avez compris et retenu du TP, quelles questions vous ont posé le plus de difficultés.

Il vous servira également lorsque vous reverrez vos cours à revoir vos réponses et résultats, à vous souvenir de ce que vous avez fait.

Enfin, la plupart seront notés et compteront pour votre moyenne.

## Le fond

- Chaque question fera l'objet d'une ligne (au moins) dans le rapport.
- N'oubliez pas de numéroter les questions, et n'en oubliez-pas. 
- De nombreuses questions vous demanderont une réflexion ou interprétation personnelle. 
    - Ne les laissez pas de côté : ce sont celles qui vous rapportent le plus de points.
    - Rédigez une réponse avec des phrases complètes.

- Vous écrirez à la fin du rapport un petit paragraphe de synthèse pour résumer ce que vous avez fait et appris dans le TP, et si vous le souhaitez vous pourrez rajouter une réflexion personnelle montrant que vous prenez du recul sur ce que vous avez fait. Tout cela est évidemment valorisé en plus de vous habituer à réfléchir à votre travail.

## La forme

### Généralités
- Le compte rendu sera au format Markdown, que vous exporterez en PDF. Plus bas vous trouverez un point sur le Markdown.
- Vous devrez le faire pendant la séance de TP, noter vos résultats et observations au fur et à mesure. 
- Je le récupère à la fin de la séance, dans un répertoire partagé que je vous communiquerai à environ 15-20 minutes de la fin. N'hésitez pas à me le rappeler. 
- Si votre rapport n'est pas rendu, vous aurez zéro.
- Pour nommer votre rapport, utilisez la nomenclature suivante : `yyyy-mm-dd_TPX_NOMTP_NOM_Prénom.pdf` en remplaçant `TPX_NOMTP` par le nom du sujet de TP et `yyyymmdd` par la date de la séance en mettant l'année en premier. 
    
    Par exemple, si votre premier TP de Python s'appelle `TP1_Python_Bases.pdf`, votre rapport s'appellera `2025-09-01_TP1_Python_Bases_DUPONT_Jean.pdf`

### Markdown

Le markdown est un format de fichier simple, au format texte. Les fichiers markdown ont un nom finissant par l'extension `.md`. Il respecte une syntaxe simple et lisible. 
Le but est de ne pas avoir à s'encombrer de la mise en forme tout en gardant un rapport lisible et propre.

Pour écrire votre rapport en markdown, utilisez un simple éditeur de texte (et non pas un logiciel de traitement de texte), idéalement VSCode qui possède des extensions pour vous aider. Ça tombe bien, c'est également l'éditeur que l'on utilisera pour la plupart des TP.

Utilisez l'extension **Markdown Preview Enhanced** (id `shd101wyy.markdown-preview-enhanced`) :

![alt text](extension-md.png)

Elle vous permet d'avoir un aperçu en direct de votre rapport et de l'exporter en PDF.

#### Aperçu en direct

Pour avoir un aperçu cliquer dans le coin en haut à droite sur l'icone représentant deux rectangles avec une loupe

![cliquer ici pour aperçu](apercu-md.png)

Cela ouvrira un deuxième volet avec l'aperçu en temps réel de votre rapport.

#### Exporter le rapport en PDF

Pour exporter le rapport en fin de séance : dans l'aperçu, en bas à droite, cliquer sur le menu à trois barres et allez dans 
`Export > Chrome(Pupeeter) > PDF`

![alt text](image.png)

![alt text](image-1.png)

Et vous verrez le fichier PDF apparaître à côté de votre rapport markdown, avec le même nom.

#### Les bases de la syntaxe markdown

##### Le texte
En markdown vous pouvez écrire du texte simplement. 
- Pour passer à la ligne, sautez une ligne. 
- Pour écrire en **gras** ou *italique* écrivez `**gras** ou *italique*`
- Pour un titre vous pouvez utiliser des `#` suivis d'un espace devant votre titre.

    ```
    # Titre principal (H1)
    ## Titre secondaire (H2)
    ### Titre tertiaire (H3)
    #### Et (H4)
    ##### Ainsi (H5)
    ###### De suite (H6)
    ```

- Pour les listes numérotées (ordonnées), mettez `1.` et markdown se chargera de mettre les bons numéros:
    ```
    1. Premier item
    1. Deuxième item
    1. Troisième item
    ```

    1. Premier item
    1. Deuxième item
    1. Troisième item

- Pour les listes non ordonnées, de simples tirets font l'affaire :
    ```
    - Premier item
    - Deuxième item
    - Troisième item
    ```
    - Premier item
    - Deuxième item
    - Troisième item


##### Le code

Pour mettre du code sur une ligne : ``` `code` ``` (guillemets de la touche 7)

Pour mettre un bloc de code, utilisez les guillemets de la touche 7 suivis (optionnellement) du nom du langage (en minuscules)
````
```python 
def fonction(arg1, arg2):
    return arg1 + arg2
```
````

Cela rendra un joli bloc de code comme celui-ci, avec la coloration syntaxique :
```python 
def fonction(arg1, arg2):
    return arg1 + arg2
```

De ce fait il n'est **pas utile de faire de screenshots**. Vous pouvez (et c'est préférable) copier votre code directement dans le rapport. Il en va de même pour la sortie du terminal : un simple bloc de code (sans langage précisé) suffit.

Si je souhaite un screenshot dans le rapport, je le préciserai.

##### Les images
Pour inclure des images, coller une image précédemment collée directement dans le fichier markdown peut suffire. Sinon, enregistrez une image dans le même répertoire que votre rapport puis utilisez la syntaxe suivante : `![texte si l'image ne s'affiche pas](mon-image.png)`

##### Les tableaux

Pour les rares cas où vous avez besoin d'un tableau, voici la syntaxe :

```
|Colonne 1|Colonne 2|Colonne 3|
|---------|---------|---------|
|Texte|Exemple|Etc|
|Encore|une|ligne
|Pour|le|plaisir|
```

Cela rendra un tableau :
|Colonne 1|Colonne 2|Colonne 3|
|---------|---------|---------|
|Texte|Exemple|Etc|
|Encore|une|ligne
|Pour|le|plaisir|


##### Toujours plus de syntaxe

Vous pouvez avoir plus d'informations sur la syntaxe markdwon ici : https://www.markdownguide.org/cheat-sheet/