Formating in README

This commit is contained in:
Benjamin Bertrand 2016-08-17 14:53:17 +03:00
parent 785ce0aa82
commit b4d79fd398

View File

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