Formating in README

This commit is contained in:
Benjamin Bertrand 2016-08-17 14:53:17 +03:00
parent 785ce0aa82
commit b4d79fd398
1 changed files with 41 additions and 48 deletions

View File

@ -29,65 +29,58 @@ mathématiques. Voici ce qu'il est capable de faire:
personnels, des fiches de révisions ou des exercices en classe, un
générateur d'expressions est inclus.
> ``` {.sourceCode .python}
> >>> from pymath import Expression
> >>> ajout_fraction = Expression.random("{a} + {b} / {c}")
> >>> print(ajout_fraction)
> 2 + \frac{ 3 }{ 5 }
> ```
``` python
>>> from pymath import Expression
>>> ajout_fraction = Expression.random("{a} + {b} / {c}")
>>> print(ajout_fraction)
2 + \frac{ 3 }{ 5 }
```
- *Gérer différents type de données*: Pour le moment, pyMath est
capable de gérer les entiers naturels, les rationnels (sous forme
de fractions) et les polynômes. L'utilisation des nombres à virgules
et des racines devraient être ajoutés dans les prochaines versions.
> ``` {.sourceCode .python}
> >>> from pymath import Fraction
> >>> une_fraction = Fraction(1,2)
> >>> print(une_fraction)
> 1 / 2
> >>> from pymath import Polynom
> >>> un_polynom = Polynom([1,2,3])
> >>> print(un_polynom)
> 3 x^{ 2 } + 2 x + 1
> ```
``` python
>>> from pymath import Fraction
>>> une_fraction = Fraction(1,2)
>>> print(une_fraction)
1 / 2
>>> from pymath import Polynom
>>> un_polynom = Polynom([1,2,3])
>>> print(un_polynom)
3 x^{ 2 } + 2 x + 1
```
- *Afficher avec deux types de rendus*: Un en mode texte pour
l'affichage dans une console. Un deuxième spécialement pour écrire
des documents latex.
> ``` {.sourceCode .python}
> >>> from pymath import Expression
> >>> ajout_fractions = Expression("2 / 5 + 2 / 3")
> >>> for i in ajout_fractions.simpliy().explain():
> ... print(i)
> ...
> \frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
> \frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
> \frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
> \frac{ 6 + 10 }{ 15 }
> \frac{ 16 }{ 15 }
> >>> from pymath import txt
> >>> with Expression.tmp_render(txt):
> ... for i in ajout_fractions.simpliy().explain():
> ... print(i)
> ...
> 2 / 5 + 2 / 3
> ( 2 * 3 ) / ( 5 * 3 ) + ( 2 * 5 ) / ( 3 * 5 )
> 6 / 15 + 10 / 15
> ( 6 + 10 ) / 15
> 16 / 15
> ```
>
> Le rendu latex permet ensuite d'être directement compiler et par
> exemple d'avoir le rendu suivant
>
> $$\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 } \\
> \frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 } \\
> \frac{ 6 }{ 15 } + \frac{ 10 }{ 15 } \\
> \frac{ 6 + 10 }{ 15 } \\
> \frac{ 16 }{ 15 }$$
``` python
>>> from pymath import Expression
>>> ajout_fractions = Expression("2 / 5 + 2 / 3")
>>> for i in ajout_fractions.simpliy().explain():
... print(i)
...
\frac{ 2 }{ 5 } + \frac{ 2 }{ 3 }
\frac{ 2 \times 3 }{ 5 \times 3 } + \frac{ 2 \times 5 }{ 3 \times 5 }
\frac{ 6 }{ 15 } + \frac{ 10 }{ 15 }
\frac{ 6 + 10 }{ 15 }
\frac{ 16 }{ 15 }
>>> from pymath import txt
>>> with Expression.tmp_render(txt):
... for i in ajout_fractions.simpliy().explain():
... print(i)
...
2 / 5 + 2 / 3
( 2 * 3 ) / ( 5 * 3 ) + ( 2 * 5 ) / ( 3 * 5 )
6 / 15 + 10 / 15
( 6 + 10 ) / 15
16 / 15
```
Le rendu latex permet ensuite d'être directement compilé.
Ce module a pour but d'être un outil pour faciliter la construction
d'exercices et leurs correction. Il a pour but d'être le plus simple
possible d'utilisation afin que tout le monde avec un minimum de