Skip to content

Commit ac5c3d5

Browse files
committed
update README.md
1 parent 975eb84 commit ac5c3d5

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ Implémentation de l'arithmétique modulaire pour les entiers et les polynômes.
44

55
## Librairie
66

7-
Le dossier `lib` contient le code de la librairie statique `libmod` qui est générée avec le makefile.
7+
Le répertoire `lib` contient le code de la librairie statique `libmod`. Pour compiler la librairie depuis la racine :
8+
```
9+
make lib/libmod.a
10+
```
11+
12+
### Arithmétiques
13+
814
Quatre arithmétiques différentes sont implémentées :
915

1016
- [x] `integer` : arithmétique d'entiers
@@ -22,20 +28,48 @@ La librairie définit les quatre types suivants :
2228
- `polynomial` : polynôme d'entiers
2329
- `degree` : degré d'un polynôme
2430

31+
### Séries formelles
32+
33+
Les fichiers `fps` définissent des fonctions pour manipuler les séries formelles.
34+
Le type `fps` permet de définir une série formelle tronquée, et `prec` renseigne sa précision.
35+
2536
## Exemples
2637

27-
Le dossier `examples` contient des exemples d'utilisation de la librairie `libmod`. Pour compiler un exemple :
38+
Le répertoire `examples` contient des exemples d'utilisation de la librairie `libmod`.
39+
- Pour compiler un exemple :
2840
```
2941
cd examples
3042
make example1.out
3143
```
32-
La commande `make` permet aussi de tout compiler. Le README du dossier `examples` montre le rôle de chaque exemple.
44+
- Pour compiler tous les exemples :
45+
```
46+
cd examples
47+
make
48+
```
49+
Le README du répertoire `examples` montre le rôle de chaque exemple.
3350

3451
## Exécutables
3552

36-
Le dossier `src` contient les fonctions principales pour générer des exécutables utilisant la librairie `libmod`.
53+
Le répertoire `src` contient les fonctions principales pour générer des exécutables utilisant la librairie `libmod`.
3754

38-
Les exécutables suivants sont créés avec la commande `make`.
55+
### Compilation
56+
57+
- Pour compiler tous les exécutables :
58+
```
59+
make
60+
```
61+
- Pour compiler l'exécutable **extendedGcdInt.out** :
62+
```
63+
cd src
64+
make ../extendedGcdInt.out
65+
```
66+
Protocole similaire pour tous les exécutables ci-dessous.
67+
68+
Les exécutables créés se trouvent à la racine du répertoire.
69+
70+
### Description
71+
72+
Voici la liste des exécutables :
3973

4074
- **extendedGcdInt.out** : algorithme d'Euclide étendu pour les entiers. Exemple ([source](https://en.wikipedia.org/wiki/Extended_Euclidean_algorithm#Example)) :
4175
```
@@ -184,6 +218,8 @@ L(4) = 6
184218

185219
## Algorithmes
186220

221+
Voici la liste des algorithmes implémentés (ou à faire) :
222+
187223
- [x] [Algorithme d'Euclide étendu](https://fr.wikipedia.org/wiki/Algorithme_d%27Euclide_%C3%A9tendu) (pour les entiers et les polynômes)
188224
- [x] [Méthode de Ruffini-Horner](https://fr.wikipedia.org/wiki/M%C3%A9thode_de_Ruffini-Horner)
189225
- [ ] Évaluation multipoint rapide
@@ -194,7 +230,7 @@ L(4) = 6
194230

195231
## Documentation
196232

197-
La documentation peut être générée avec la commande :
233+
La documentation peut être générée par `doxygen` avec la commande :
198234
```
199235
make docs
200236
```

0 commit comments

Comments
 (0)