From ec87f96ffec31c430b6058663ae831c1b3a29ff9 Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Sat, 13 Apr 2024 17:15:42 +0200 Subject: Clean up --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 041b8d3..131c7ed 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,30 @@ A simple set of basic routines for working with a 3x3x3 Rubik's Cube. -Work in progress. - ## How to use CubeCore -TODO +(More details coming soon) + +0. Requirements: a C99 compiler (e.g. GCC) + +1. Compile CubeCore + +``` +$ make +$ make test # optional +``` + +2. Include in your C or C++ project + +``` +#include "cube.h" +``` + +3. Compile including the `cube.o` file + +``` +$ gcc mycode.c cube.o +``` ## The cube -- cgit v1.3