Commit 445649db authored by Guillaume CLOCHARD's avatar Guillaume CLOCHARD
Browse files

Merge branch 'documentation' into 'master'

Amélioration README

- Plus de lisibilité de la doc des arguments de `poqb.py`
- Ajout début d'exemple du retour de solve()

See merge request !21
parents 994d3d4b dfc0214d
......@@ -12,34 +12,50 @@ Projet d'Algorithmique et Programmation INFO3 Polytech Nantes.
python poqb.y --cube OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG
```
# Utilisation
## Dépendances
- Python 3
- Numpy (`pip install numpy`).
## Terminal
```bash
python poqb.py [--cube | -c] <cube> [--tuto] [--auto] [--speed | -s] <speed> [--colors]
```
- `--cube <cube>` (optionnel). Un cube à résoudre. Par défaut on résout
`OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG`.
Format : 54 couleurs parmis {Y, B, R, G, O, W} pour les 54 facettes.
- `--cube <cube>` (optionnel). Un cube à résoudre.
Par défaut on résout `OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG`.
Format : 54 couleurs parmis {Y, B, R, G, O, W} pour les 54 facettes.
- `-c<cube>` (optionnel). Voir `--cube`.
- `--tuto` (optionnel). Activer le mode tutoriel qui affiche la résoltution du
cube pas à pas.
- `--auto` (optionnel). Avec `--tuto`, avancée automatique.
- `--speed <speed>` (optionnel). La vitesse d'avancée avec `--auto` en
mouvements par secondes. Défaut 2/sec.
- `--tuto` (optionnel).
Activer le mode tutoriel qui affiche la résoltution du cube pas à pas.
- `--auto` (optionnel).
Avec `--tuto`, avancée automatique.
- `--speed <speed>` (optionnel).
La vitesse d'avancée avec `--auto` en mouvements par secondes. Défaut 2/sec.
- `-s<speed>` (optionnel). Voir `--speed`.
- `--colors` (optionnel). Activer les couleurs ascii sous Windows, par exemple
- `--colors` (optionnel).
Activer les couleurs ascii sous Windows, par exemple
dans Git Bash.
## Module
```python
import poqb #import du fichier poqb.py
print(poqb.solve('OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG'))
#U2F2F'...
```
# En savoir plus
[:link: Wiki Gitlab](https://gitlab.univ-nantes.fr/E132397K/Ragnulf/wikis/home)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment