From 67cc77ae11ac34e46b70aa29924641b4101767b9 Mon Sep 17 00:00:00 2001 From: Corentin Lingier Date: Sat, 16 May 2020 09:35:26 +0200 Subject: [PATCH] Documentation --- README.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9a056f8..ba565c7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,27 @@ # Factorization en nombres premiers Dans ce projet se trouve une implémentation d'un algorithme efficace pour décomposer des nombres -en nombres premiers. Il se base sur deux algorithmes clés que nous détaillerons ici. +en nombres premiers. Il se base sur deux algorithmes clés que nous détaillerons ici. Une documentation +complete se trouve sur la branche documentation/index.html. Elle peut aussi etre générée à l'aide de +la commande à la racine du projet: +``` +doxygen +``` ## Getting Started/Installation +Le projet dépend de plusieurs librairies: +``` +gcc +make +gmp +cunit +pthread +``` + Pour build le binaire, exécutez à la **racine** du projet: ``` $> make fact ``` -Les dépendances du projets sont les librairies `pthread`, `gmp`, `cunit`. Veuillez -vous assurer de leur installation avant d'exécuter la commande ci-dessus. Pour utiliser ce binaire veuillez suivre cet usage: ``` @@ -136,20 +148,13 @@ Le code est structuré en dossier afin de faciliter sa lisibilité. Dans chaque Dans le dossier prime_divs, il y a différentes dossiers: -- "data": Ce dossier contient tous le code qui concerne la data (comme par exemple les fonctions pour lire et écrire dans des fichiers) +- "data": Ce dossier contient tous l'implémentation d'une liste chainée utilisée dans tout le projet pour stocker nos résultats. - "deprectated": Ce dossier contien du code obsolète, qui n'est donc plus utilisé. - "factorisation": Dans ce dossier se trouve les deux algorithmes de factorisation, "factor_small_integer" reprend l'implémentation du Sieve d'Eratosthenes tandis que "factor_big_integer" reprend celle du Pollard Rho. -- "multithreading": Dans le dossier se trouvent toutes les fonctions qui concernent le multithreading et les buffer. - -En plus, il se trouve le dossier 'include' ainsi que le fichier main. - -``` -Give an example -``` - +- "multithreading": Dans le dossier se trouvent toutes les fonctions qui concernent le multithreading et l'implémentation du problème producteur-consommateur. ### Scripts -- GitLab