diff options
| author | Sebastiano Tronto <sebastiano@tronto.net> | 2025-04-22 14:11:38 +0200 |
|---|---|---|
| committer | Sebastiano Tronto <sebastiano@tronto.net> | 2025-04-22 14:11:38 +0200 |
| commit | e391c4624055138f075c0e5772ccaf8ede094b5a (patch) | |
| tree | 56f0566dda438d2342b71a200db6b48a5bc70da4 /src/nissy.h | |
| parent | cd866d68cf1bf6ea928cc48a4f2b753c0b1baa6f (diff) | |
| download | nissy-core-e391c4624055138f075c0e5772ccaf8ede094b5a.tar.gz nissy-core-e391c4624055138f075c0e5772ccaf8ede094b5a.zip | |
Updated documentation
Diffstat (limited to 'src/nissy.h')
| -rw-r--r-- | src/nissy.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/nissy.h b/src/nissy.h index 963571f..4b2d1eb 100644 --- a/src/nissy.h +++ b/src/nissy.h | |||
| @@ -2,14 +2,14 @@ | |||
| 2 | This is libnissy (temporarily also known as h48), a Rubik's cube library. | 2 | This is libnissy (temporarily also known as h48), a Rubik's cube library. |
| 3 | 3 | ||
| 4 | All the functions return 0 or a positive integer in case of success and | 4 | All the functions return 0 or a positive integer in case of success and |
| 5 | a negative integer in case of error, unless otherwise specified. See at | 5 | a negative integer in case of error, unless otherwise specified. See |
| 6 | the bottom of this file for the list of error codes and their meaning. | 6 | below for the list of error codes and their meaning. |
| 7 | 7 | ||
| 8 | TODO: explain cube format | 8 | Cubes are passed as strings in the cccccccc=eeeeeeeeeeee=r format, |
| 9 | see the README.md file for more information. | ||
| 9 | 10 | ||
| 10 | Accepted moves are U, D, R, L, F and B, optionally followed by a 2, | 11 | Accepted moves are U, D, R, L, F and B, optionally followed by a 2, |
| 11 | a ' or a 3. | 12 | a ' or a 3. |
| 12 | TODO update when we accept also wide moves, slices and rotations | ||
| 13 | 13 | ||
| 14 | A transformation must be given in the format | 14 | A transformation must be given in the format |
| 15 | (rotation|mirrored) (2 letters) | 15 | (rotation|mirrored) (2 letters) |