quentinlegot/L-System
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update and rename README.txt to README.md

Browse Source
This commit is contained in:
Quentin Legot 2021-07-22 14:30:12 +02:00 committed by GitHub
parent f7ab561364
commit d39771c7b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# L-System
## Contributors:
[Antonin Boyon](https://github.com/Detextra)
[Arthur Page](https://github.com/Arthur7770)
[Quentin Legot](https://github.com/SexiestCHiba)
[Thomas Lalong](https://github.com/Kyurah)
## Informations
Our project aims to create an application for the generation of video-fun flora
The source code is in the `src/` directory, the source code for the tests is in the `test/` directory
The overview.html file as well as the `src/**/package-info.java` files are used when generating the javadoc
To compile the source files in the `bin/directory`, run the command: `ant compile`
To compile then run the program, run the command: `ant run`
To generate a jar archive in the `build/directory`, run the command: `ant packaging`
To generate the javadoc in the `doc/` folder, run the command: `ant javadoc`
Then open the index.html or overview-summary.html file in a browser.
To perform the tests, run the command: `ant tests`
A result.txt file will be generated displaying the results as well as a copy of the standard output.
All files are in the archive, so compilation and execution do not require internet connection
## Dependency websites used:
[Java OpenGL](https://jogamp.org/jogl/www/)
[JUnit 4](https://junit.org/junit4/)

37
README.txt
View File

@ -1,37 +0,0 @@
# L-System
## Membres du groupe:
Antonin Boyon
Arthur Page
Quentin Legot
Thomas Lalong
## Informations
Notre projet a pour but de réaliser une application de génération de flores vidéos-ludiques
Le code source se trouve dans le répertoire src/, le code source des tests se trouve dans le répertoire test/
Le fichier overview.html ainsi que les fichiers src/**/package-info.java sont utilisés lors de la génération de la javadoc
Pour compiler les fichiers sources dans le répertoire bin/, executez la commande: ant compile
Pour compiler puis executer le programme, executez la commande: ant run
Pour générer une archive jar dans le répertoire build/, executez la commande: ant packaging
Pour générer la javadoc dans le dossier doc/, executez la commande: ant javadoc
Ouvrez ensuite le fichier index.html ou overview-summary.html dans un navigateur.
Pour effectuer les tests, executez la commande: ant tests
Un fichier result.txt sera généré affichant les résultats ainsi qu'une copie de la sortie standard.
Tout les fichiers se trouvent dans l'archive, ainsi la compilation et l'éxecution ne nécessite pas de connnexion internet
## Sites internet des librairies utilisés:
https://jogamp.org/jogl/www/
https://junit.org/junit4/