README.md 1.7 KB
Newer Older
Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
1
![Newcastle Vikings Logo from Wikipedia by Garethom](https://upload.wikimedia.org/wikipedia/commons/3/33/NewcastleVikingsLogo.PNG)
Jimmy LEBLANC's avatar
Jimmy LEBLANC committed
2

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
3
4
Ragnulf
=======
Jimmy LEBLANC's avatar
Jimmy LEBLANC committed
5

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
6
7
Résolution d'un Rubik's Cube par la méthode CFOP.

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
8
# TL;DR
9
10
11
```bash
python poqb.y --cube OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG
```
Jimmy LEBLANC's avatar
Jimmy LEBLANC committed
12

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
13
14
![Animation](animation.gif)

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
15
# Utilisation
16

Guillaume CLOCHARD's avatar
Guillaume CLOCHARD committed
17
18
19
20
21
## Dépendances

- Python 3
- Numpy (`pip install numpy`).

22
23
## Terminal
```bash
Jimmy DORE's avatar
Jimmy DORE committed
24
python poqb.py [--cube | -c] <cube> [--tuto] [--auto] [--speed | -s] <speed>  [--moves] [--colors]
25
26
```

27
28
29
30
31
32
- `--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.

33
- `-c<cube>` (optionnel). Voir `--cube`.
34
35
36
37
38
39
40
41
42
43
44
45
- `--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.

46
- `-s<speed>` (optionnel). Voir `--speed`.
Jimmy DORE's avatar
Jimmy DORE committed
47
48
49
50

- `--moves` (optionnel). Afficher la représentation des mouvements à effectuer sur le cube
    en plus du patron coloré.

51
52
53
- `--colors` (optionnel).

    Activer les couleurs ascii sous Windows, par exemple
54
55
56
57
58
59
    dans Git Bash.

## Module
```python
import poqb #import du fichier poqb.py
print(poqb.solve('OGRBWYBGBGYYOYOWOWGRYOOOBGBRRYRBWWWRBWYGROWGRYBRGYWBOG'))
60
#U2F2F'...
61
62
```

63
64
65
66
67
68
# Tests
Pour lancer les tests unitaires :
```python
python -m unittest discover -v
```

69
70
71
72
73
74
Ou, avec `green` (`pip3 install green`), pour avoir un peu de couleurs :
```python
green -vvv
#ou
green -vvv -r #avec coverage d'installé sur la machine
```