Commit 5ef64da4 authored by Le Goff Gawein's avatar Le Goff Gawein
Browse files

Add README.md

parent b504aeff
# Description
Py4Kids est une application éducative réalisée dans le cadre de la [bourse Coddity 2020](https://bourse.coddity.com/), visant à favoriser l'apprentissage de la programmation de manière ludique chez les enfants et adolescents. Ceux-ci seront guidés dans la découverte du langage Python, qu'ils utiliseront pour programmer un robot se déplacant sur une grille afin de résoudre divers exercices
# Pré-requis
Pour utiliser l'application, un Java Runtime Environment (JRE) version 1.8 ou supérieure est requis.
Un Java Development Kit (JDK) à jour ainsi que une version récente de [Maven](https://maven.apache.org/download.cgi) (voir [ici](https://howtodoinjava.com/maven/how-to-install-maven-on-windows/) pour l'installation sous Windows si besoin) sont également requis pour compiler l'application à partir des sources.
A titre d'indication, l'application a été testée avec les versions suivantes des logiciels requis :
- JRE 1.8.0_191
- JDK 14.0.1
- Maven 3.6.3
# Utilisation
Des versions pré-compilées sont disponibles sous forme d'exécutable Windows et d'archive .jar pour les autres plateformes disposant de Java sur la page des releases.
Si vous souhaitez compiler vous même l'application, veuillez vous référer à la section ci-dessous.
# Compilation
La compilation du projet se fait en exécutant la commande suivante dans un terminal/invite de commandes à la racine du projet
mvn clean compile assembly:single
Cette commande génère un .jar dans le dossier target. Celui-ci doit être déplacé à la racine du projet afin d'être ensuite exécuté.
Si vous souhaitez placer le .jar dans un autre dossier, veuillez noter que le dossier src/main/python ainsi que son contenu sont nécessaires à l'exécution du programme. Il doit donc être déplacé dans le même dossier que le .jar
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment