Aller au contenu principal

01 Outils

Objectifs

Préparer l'environnement de travail.

  • Installer les outils nécessaires
  • Créer un compte GitHub
  • Configurer Git
  • Rendre une présentation en PDF sur Moodle

Rendu

Installation

Windows

Pour les utilisateurs Windows, commencer par installer Windows Terminal.

Conseils
  • Préférer les versions stables (LTS pour long term support) aux versions plus récentes (p. ex. Node.js)
    • Moins de bugs potentiels
  • Préférer les versions officielles aux versions tierces (p. ex. Python au lieu de Anaconda)
    • Plus sûr de ce qui est installé
  • Windows : Utiliser cmder comme terminal (disponible via Chocolatey)

Installer les outils suivants :

  • Gestionnaire de paquets
    • macOS : Homebrew
      • Ne pas oublier de lancer les commandes indiquées à la fin de l'installation
    • Windows : Chocolatey
      • Lancer le terminal en tant qu'administrateur pour installer Chocolatey
  • Navigateur web (un parmi Mozilla Firefox, Google Chrome ou Microsoft Edge)
  • Visual Studio Code
    • Avec l'extension Live Server
      • Extensions > Rechercher Live Server > Installer
  • Git
    • macOS : brew install git
    • Windows : choco install git
    • Vérifier avec git --version dans un terminal (v2.46)
  • Node.js
    • macOS : brew install node
    • Windows : choco install nodejs
    • Vérifier avec node --version dans un terminal (v20.17)
    • Possibilité d'utiliser nvm pour gérer les versions de Node.js
  • Python
    • macOS : brew install python
    • Windows : choco install python
    • Vérifier avec python --version dans un terminal (v3.12)
      • Possiblement python3 --version sur macOS
    • Possibilité d'utiliser pyenv pour gérer les versions de Python
  • GitHub Desktop
    • Pour une interface graphique à Git

Créer un répertoire pour le cours (par exemple un dossier bs21inf5 dans le dossier hep dans vos documents) pour y mettre tous les projets du cours.

GitHub

  • Créer un compte sur GitHub
    • Utiliser une adresse e-mail privée afin de réutiliser le compte après la formation
  • Configurer Git
    • Avec GitHub Desktop
    • Avec le terminal
      • git config --global user.name "Prénom Nom"
        • Par exemple : git config --global user.name "jane Doe"
      • git config --global user.email "email@example.com"
        • Par exemple : git config --global user.email "jane.doe@etu.hepl.ch"
      • Fins de ligne pour Windows : git config --global core.autocrlf true
  • Accepter le devoir sur GitHub Classroom

Terminal

  • Ouvrir un terminal
    • macOS : Cmd + Space puis taper terminal
    • Linux : Ctrl + Alt + T
    • Windows : Win + R puis taper wt
  • Pour exécuter une commande, il suffit de taper le nom de la commande puis la touche Enter. Essayez les commandes suivantes :
    • ls pour lister les fichiers et répertoires
    • pwd pour afficher le chemin absolu du répertoire courant
  • Naviguer dans les répertoires jusqu'à celui du cours
    • cd {chemin_relatif_ou_absolu} pour changer de répertoire (cd pour change directory)
    • cd .. pour remonter d'un niveau
    • La touche Tab permet de compléter automatiquement le nom des fichiers et répertoires
    • Les touches fléchées et permettent de se déplacer dans la ligne de commande
    • Les touches fléchées et permettent de naviguer dans l'historique des commandes
    • Le raccourci Ctrl + C permet d'annuler une commande en cours
  • Une fois dans le répertoire du cours, vérifier avec pwd.
  • Cloner le dépôt du devoir sur GitHub Classroom sur votre machine
    git clone {url_du_depot}
    • macOS : Installer et utiliser GitHug CLI (brew install gh) pour vous authentifier en cas de problème : gh auth login
  • Se déplacer dans le répertoire du dépôt Git
    cd sem01-outils-{pseudo}
  • Créer un répertoire terminal (mkdir pour make directory)
    mkdir terminal
  • Se déplacer dans le répertoire terminal
    cd terminal
  • La commande echo permet d'afficher du texte dans le terminal
    echo 'Hello, World!'
  • Elle permet aussi de créer un fichier avec du texte
    echo 'Hello, World!' > hello.txt
    • Vérifier le contenu du fichier avec votre navigateur de fichiers
    • Une alternative est d'utiliser la commande touch pour créer un fichier vide
      touch empty.txt
  • Pour lire un fichier dans le terminal, on utilise la commande cat (pour concatenate)
    cat hello.txt
  • Pour copier un fichier, on utilise la commande cp (pour copy)
    cp hello.txt hello-2.txt
    • Vérifier le contenu du fichier copié
  • Copier une seconde fois le fichier
    cp hello.txt hello-3.txt
  • Déplacer un fichier avec la commande mv (pour move)
    mv hello-3.txt hello-4.txt
    • Vérifier que le fichier a bien été renommé
      ls
  • Supprimer un fichier avec la commande rm (pour remove)
    rm hello-4.txt
    • Vérifier que le fichier a bien été supprimé

Git

  • Revenir dans le répertoire du dépôt Git
    cd ..
  • Vérifier l'état du dépôt Git
    git status
  • Ajouter les fichiers créés dans le "staging area" (zone de préparation)
    git add --all
  • Vérifier que les fichiers ont bien été ajoutés
    git status
  • Créer un "commit" avec un message
    git commit -m "ajouter les exercices sur le terminal"
  • Envoyer le commit sur le dépôt distant
    git push

Configuration

  • Configurer votre ordinateur pour qu'il affiche les extensions des fichiers
    • macOS : Finder > Préférences > Avancé > Cocher "Afficher toutes les extensions de fichier"
    • Windows : Explorer > Affichage > Options > Modifier les options des dossiers et de recherche > Affichage > Décocher "Masquer les extensions des fichiers dont le type est connu"
  • Configurer votre ordinateur pour qu'il affiche les fichiers cachés
    • macOS : Finder > Cmd + Shift + .
    • Windows : Explorer > Affichage > Options > Modifier les options des dossiers et de recherche > Affichage > Cocher "Afficher les fichiers, dossiers et lecteurs cachés"

Présentation

  • Écrire une brève présentation de soi avec ses centres d'intérêt, ses compétences en informatique, pourquoi avoir choisi cette formation, etc.
  • Rendre la présentation au format PDF nommé presentation-prenom-nom.pdf (avec votre prénom et nom, tout en minuscule, sans accent, sans espace avec des tirets) sur Moodle

Markdown

Le Markdown est un langage de balisage léger. Il est utilisé pour formater du texte de manière simple et lisible. Les rapports à rendre pour le cours seront rédigés en Markdown.

  • Créer un fichier report.md dans le dépôt Git avec un contenu similaire à ci-dessous
    • Modifier et compléter le contenu du tableau avec les tâches effectuées, le temps passé et éventuellement des commentaires
    • Markdown Cheatsheet
    • Possibilité d'utiliser vim pour éditer le fichier (pour apprendre)
      • vim report.md
      • Pour éditer, taper i
      • Pour quitter, taper Esc puis :wq puis Enter
  • Plusieurs outils permettent de visualiser le rendu du Markdown :
    • Dillinger
    • Visual Studio Code : Ctrl/Cmd + Shift + V lors de l'édition d'un fichier Markdown
  • Ajouter le fichier au dépôt Git et le pousser sur le dépôt distant
./report.md
# Séminaire 01 - Outils

[Prénom Nom]

## Temps passé

| Tâche | Temps passé | Commentaire |
| ------------ | ----------- | ------------------------------ |
| Installation | 1h | |
| GitHub | 30m | difficulté à trouver un pseudo |
| ... | ... | ... |
| Total | 2h30 | |

Raccourcis clavier

Les raccourcis clavier sont des combinaisons de touches qui permettent d'effectuer des actions bien plus rapidement. Voici quelques raccourcis clavier utiles :

  • Cmd + C : Copier
  • Cmd + V : Coller
  • Cmd + X : Couper
  • Cmd + Z : Annuler
  • Cmd + S : Enregistrer
  • Cmd + A : Tout sélectionner
  • Cmd + F : Rechercher

Organisation

  • Prendre du temps pour organiser son espace de travail afin d'être plus efficace.
    • Avoir un dossier par cours
    • Nettoyer les fichiers inutiles

Pour aller plus loin

Références