diff --git a/README.md b/README.md index 2d879d4c2eb1660159244f790ae685ad042391c4..dba490338c6787c95a9462ff675e7ce9b472db53 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # saeshukan -SAe project about Shukan planner for BUT INFO students +Ce programme permet de visualiser et de gérer la planification des cours d'un IUT en fonction des semaines. -A documentation of Shukan and Shukan scripts (shukan.html) is available in doc directory. +Pour compiler, placez vous dans le répertoire du projet et tapez dans le terminal la commande javac shukan/Shukan.java. Pour exécuter, tapez la commande java shukan.Shukan. + +Le logiciel se compose d'une barre d'outils et d'un planning. Il est possible d'ajouter un cours (bouton +), de déplacer des cours (boutons <- et ->), de supprimer un cours grâce au bouton en forme de poubelle, de changer de semestre (bouton S+/-) et de changer les couleurs utilisées grâce au bouton paramètre. Il est aussi d'exporter le planning en fichier .tex. -A documentation of Shukan architecture (archiShukan.pdf) is also available in doc directory.