diff options
| author | Sebastiano Tronto <sebastiano@tronto.net> | 2024-04-13 19:22:49 +0200 |
|---|---|---|
| committer | Sebastiano Tronto <sebastiano@tronto.net> | 2024-04-13 19:22:49 +0200 |
| commit | 59ecc0ee72a180692fcccab88db310d60021f2ab (patch) | |
| tree | 0038b500b6af1bb5b5c95e5aed590ce33b13401b /README.md | |
| parent | ec87f96ffec31c430b6058663ae831c1b3a29ff9 (diff) | |
| download | cubecore-59ecc0ee72a180692fcccab88db310d60021f2ab.tar.gz cubecore-59ecc0ee72a180692fcccab88db310d60021f2ab.zip | |
Fixed howto, added example
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
| @@ -4,7 +4,7 @@ A simple set of basic routines for working with a 3x3x3 Rubik's Cube. | |||
| 4 | 4 | ||
| 5 | ## How to use CubeCore | 5 | ## How to use CubeCore |
| 6 | 6 | ||
| 7 | (More details coming soon) | 7 | See the example in `example/` for details. |
| 8 | 8 | ||
| 9 | 0. Requirements: a C99 compiler (e.g. GCC) | 9 | 0. Requirements: a C99 compiler (e.g. GCC) |
| 10 | 10 | ||
| @@ -15,12 +15,20 @@ $ make | |||
| 15 | $ make test # optional | 15 | $ make test # optional |
| 16 | ``` | 16 | ``` |
| 17 | 17 | ||
| 18 | 2. Include in your C or C++ project | 18 | 2. Include in your C project |
| 19 | 19 | ||
| 20 | ``` | 20 | ``` |
| 21 | #include "cube.h" | 21 | #include "cube.h" |
| 22 | ``` | 22 | ``` |
| 23 | 23 | ||
| 24 | or in your C++ project | ||
| 25 | |||
| 26 | ``` | ||
| 27 | extern "C" { | ||
| 28 | #include "cube.h" | ||
| 29 | } | ||
| 30 | ``` | ||
| 31 | |||
| 24 | 3. Compile including the `cube.o` file | 32 | 3. Compile including the `cube.o` file |
| 25 | 33 | ||
| 26 | ``` | 34 | ``` |
