aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 131c7ed..a1b260a 100644
--- a/README.md
+++ b/README.md
@@ -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) 7See the example in `example/` for details.
8 8
90. Requirements: a C99 compiler (e.g. GCC) 90. 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
182. Include in your C or C++ project 182. Include in your C project
19 19
20``` 20```
21#include "cube.h" 21#include "cube.h"
22``` 22```
23 23
24or in your C++ project
25
26```
27extern "C" {
28#include "cube.h"
29}
30```
31
243. Compile including the `cube.o` file 323. Compile including the `cube.o` file
25 33
26``` 34```

Generated with cgit - Back to sebastiano.tronto.net