diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 22 insertions, 3 deletions
| @@ -2,11 +2,30 @@ | |||
| 2 | 2 | ||
| 3 | A simple set of basic routines for working with a 3x3x3 Rubik's Cube. | 3 | A simple set of basic routines for working with a 3x3x3 Rubik's Cube. |
| 4 | 4 | ||
| 5 | Work in progress. | ||
| 6 | |||
| 7 | ## How to use CubeCore | 5 | ## How to use CubeCore |
| 8 | 6 | ||
| 9 | TODO | 7 | (More details coming soon) |
| 8 | |||
| 9 | 0. Requirements: a C99 compiler (e.g. GCC) | ||
| 10 | |||
| 11 | 1. Compile CubeCore | ||
| 12 | |||
| 13 | ``` | ||
| 14 | $ make | ||
| 15 | $ make test # optional | ||
| 16 | ``` | ||
| 17 | |||
| 18 | 2. Include in your C or C++ project | ||
| 19 | |||
| 20 | ``` | ||
| 21 | #include "cube.h" | ||
| 22 | ``` | ||
| 23 | |||
| 24 | 3. Compile including the `cube.o` file | ||
| 25 | |||
| 26 | ``` | ||
| 27 | $ gcc mycode.c cube.o | ||
| 28 | ``` | ||
| 10 | 29 | ||
| 11 | ## The cube | 30 | ## The cube |
| 12 | 31 | ||
