amélioration du fichier README

This commit is contained in:
Faraphel 2024-06-30 17:58:58 +02:00
parent 5c2928597c
commit ce3cf5fb1e

View file

@ -1,12 +1,22 @@
# Master 1 - Projet de Spécialité
Ce projet consiste en une application Android permettant à des enseignants de créer des session de cours où un ensemble
d'élève est assigné à des tâches de sujet différent qui peuvent être validé collaborativement.
d'élève est assigné à des tâches qui peuvent être validées de manière collaborative.
Il est possible d'utiliser le QR code des cartes étudiantes afin de substituer l'identifiant d'un étudiant et de
pouvoir valider rapidement les tâches d'un élève.
Voici les fonctionnalités proposées :
- Connection entre plusieurs appareils en IP ou Wi-Fi Direct
- Création de session de cours contenant une classe et des enseignants
- Authentification à l'aide du QR code présent sur les cartes étudiantes
- Support de différents sujets composés de différentes questions pour chaqu'un des élèves
- Possibilité pour un enseignant de rejoindre la connection pour valider collaborativement les tâches des élèves
- Possibilité pour un étudiant de rejoindre la connection pour vérifier les tâches validées
- Exportation des données dans un fichier `JSON`
- Validation rapide permettant de valider la tâche suivante d'un élève à l'aide de son QR code
# Build
1. Cloner le projet `git clone https://git.faraphel.fr/study-faraphel/M1-PDS`
2. Ouvrer le dans Android Studio ou Intellij IDEA
1. Cloner le projet à l'aide de la commande `git clone https://git.faraphel.fr/study-faraphel/M1-PDS`
2. Ouvrer le dans [Android Studio](https://developer.android.com/studio?hl=fr) ou [Intellij IDEA](https://www.jetbrains.com/idea/)
3. Sélectionner votre téléphone dans le [menu de configuration] (https://www.jetbrains.com/help/idea/run-debug-configuration.html)
(l'utilisation d'émulateur n'est pas préconisé pour la fonctionnalité Wi-Fi Direct)
4. Démarrer l'application avec le bouton `Run`