From 59ecc0ee72a180692fcccab88db310d60021f2ab Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Sat, 13 Apr 2024 19:22:49 +0200 Subject: Fixed howto, added example --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') 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. ## How to use CubeCore -(More details coming soon) +See the example in `example/` for details. 0. Requirements: a C99 compiler (e.g. GCC) @@ -15,12 +15,20 @@ $ make $ make test # optional ``` -2. Include in your C or C++ project +2. Include in your C project ``` #include "cube.h" ``` +or in your C++ project + +``` +extern "C" { +#include "cube.h" +} +``` + 3. Compile including the `cube.o` file ``` -- cgit v1.3