From e391c4624055138f075c0e5772ccaf8ede094b5a Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Tue, 22 Apr 2025 14:11:38 +0200 Subject: Updated documentation --- src/nissy.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/nissy.h') 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 @@ This is libnissy (temporarily also known as h48), a Rubik's cube library. All the functions return 0 or a positive integer in case of success and -a negative integer in case of error, unless otherwise specified. See at -the bottom of this file for the list of error codes and their meaning. +a negative integer in case of error, unless otherwise specified. See +below for the list of error codes and their meaning. -TODO: explain cube format +Cubes are passed as strings in the cccccccc=eeeeeeeeeeee=r format, +see the README.md file for more information. Accepted moves are U, D, R, L, F and B, optionally followed by a 2, a ' or a 3. -TODO update when we accept also wide moves, slices and rotations A transformation must be given in the format (rotation|mirrored) (2 letters) -- cgit v1.3