**********Fichier README.txt***********
***************************************
*****Programme : FractalProject********
***************************************
***Alexandre Ledit & Antoine Souplet***
***************************************
*****contact : soupletant@eisti.eu*****
***************************************


###############################################
########## Compilation et execution ########### 
###############################################

Les commandes suivantes doivent être effectuées à la racine du projet (dans le repertoire "FractalProject/")

>>>Compilation du programme<<<

-"Make"
-"Make all"


>>>Compilation de la documentation<<<

-"Make doc"


>>>Affichage de la documentation dans firefox<<<

-"Make api"


>>>Suppression des fichiers binaires (contenus dans le repertoire"/bin/")

-"Make clean"


>>>Execution du programme<<<

-./bin/Fractal.exe [argument]

Lancer le programme avec l'argument -h ou --help afin d'afficher l'aide, explicant l'intégralité des fonctions associées aux arguments
Lancer le programme sans argument lance le menu de substitution, cela dit, afin d'exploiter au mieux le programme, il est conseillé d'utiliser les arguments de lignes de commande, et ainsi de pouvoir définir un plus grand nombre d'options.


###############################################
############# Actions disponibles ############# 
###############################################

>>>Actions disponibles sur toutes les fractales<<<

-"Echap" : Quitter le programme
-"Flèches de déplacement" : Gestion du déplacement
-"PgUp" : Zoomer
-"PgDown" : Dezoomer


>>>Actions disponibles sur la fractale de Mandelbrot<<<

-"+" : Augmenter le nombre d'itérations
-"-" : Réduire le nombre d'itérations
-"espace" : Changer la coloration


>>>Actions disponibles sur la fractale de Julia<<<

-"+" : Augmenter le nombre d'itérations
-"-" : Réduire le nombre d'itérations
-"espace" : Changer la coloration
-"c" : Mettre/enlever le mode itération inverse

 
>>>Actions disponibles sur les fractales de type L-Systemm<<<

-"+" : Augmenter l'indice du L-System
-"-" : Réduire l'indice du L-System


>>>Actions disponibles sur les fractales de type IFS et flamme<<<

-"+" : Augmenter le nombre de points calculés
-"-" : Réduire le nombre de points calculés
-"espace" : Changer la coloration
-"c" : Passer du mode couleur par fonction IFS au mode Monochromatique et inversement
-"Ctrl +" : Augmenter l'intensité des couleurs
-"Ctrl -" : Réduire l'intensité des couleurs


###############################################
######### Ecritures dans les fichiers ######### 
###############################################

>>>Fichier de type L-System<<<

1ère ligne : Déclaration des variables que vous souhaitées utilisées, séparées par un ";" et suivies d'un "~" si elles traçent, d'autre chose sinon
2ème ligne : Valeur de l'angle (en degré)
3ème ligne : Valeur de la longueur d'un trait (en pixel)
4ème ligne : Axiome de départ du L-System
5ème ligne : Règle de transformation de la première variable déclarée
6ème ligne : Règle de transformation de la seconde variable déclarée
Nième ligne : Règle de transformation de la Nième variable déclarée

Exemples dans le répertoire /files_config/lsystem/


>>>Fichier de type IFS<<<
	
Un fichier peut être composé de N lignes, N étant le nombre de fonctions IFS. Chaque ligne doit se présenté sous la forme suivante :
a b c d e f p ;
Où a, b, c, d, e et f sont les coefficients de la fonction IFS tels que :
f(x;y)=(ax+by+e; cx+dy+f)
p représente la probabilité d’appel de cette fonction, la somme des probabilités de toutes les lignes doit être égale à 1.

Exemples dans le répertoire /files_config/ifs/


>>>Fichier de type Flamme<<<

1ère ligne : Nom du fichier IFS associé
2ème ligne : Transformation de l'abscisse du point
3ème ligne : Transformation de l'ordonnée du point

Syntaxe des fonctions et variables disponibles pour écrire les transformations :
-"X" : coordonnée X (abscisse)
-"Y" : coordonnée Y (ordonnée)
-"Pi" : valeur de la constante Pi
-"R" : Module de X,Y
-"+" : Addition
-"-" : Soustraction
-"/" : Division
-"*" : Multiplication
-"%" : Module
-"^" : Exposant
-"." : Virgule
-"(" : parenthèse ouvrante
-")" : parenthèse fermante

Les fonctions suivantes doivent précéder une parenthèse ouvrante
-"cos" : Cosinus
-"sin" : Sinus
-"tan" : Tangente
-"acos" : Arc cosinus
-"asin" : Arc sinus
-"atan" : Arc tangente
-"hcos" : Cosinus hyperbolique
-"hsin" : Sinus hyperbolique
-"htan" : Tangente hyperbolique
-"exp" : Exponentielle
-"Sqrt" : Racine carré


Exemples dans le répertoire /files_config/flame/


###############################################
############# Aide complémentaire ############# 
###############################################

[arguments] : correspond à des arguments pouvant être rajouté afin de modifier la taille de la fenêtre, le zoom de départ ... (ces arguments sont précisés dans l'aide du programme)

-Dessiner une fractale de Mandelbrot : ./bin/Fractal.exe [arguments] -m [arguments]

-Dessiner une fractale de Julia : ./bin/Fractal.exe [arguments] -j [arguments]

-Dessiner une fractale de Julia avec mise à jour en temps réel : ./bin/Fractal.exe [arguments] -jj [arguments]

-Dessiner une fractale L-System : ./bin/Fractal.exe [arguments] -l [arguments] -li nomFichier [arguments]

-Dessiner une fractale de type IFS : ./bin/Fractal.exe [arguments] -i [arguments] -if nomFichier [arguments]

-Dessiner une fractale de type flamme : ./bin/Fractal.exe [arguments] -f [arguments] -ff nomFichier [arguments]
Pour dessiner une fractale de type flamme pré-définie, et avoir un rendu 4 fois plus rapide, il suffit de passer par le menu, ou de ne pas spécifier de fichier flamme en ligne de commande