diff --git a/README.md b/README.md index 0815b17..2fe6683 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# cube-solving-basic-algo +# Cube-solving-basic-algo Project made for [Robotics](https://www.facebook.com/robo.soc.nith/) club of [NIT-H](http://nith.ac.in/) ##### Language: [C](https://en.wikipedia.org/wiki/C_(programming_language)) @@ -9,17 +9,17 @@ Download the library to be used : [Link 1](https://drive.google.com/open?id=1b1S **To link this library to your code use these steps : *watch from `1:41`* [Youtube](https://www.youtube.com/watch?v=-3BoOuSSCeI)** -## Here is the basic layout of the cube +## Here is the basic layout of the cube: We can see that every step is in form of rotation of one of six faces in either clockwise or anti-clockwise direction relative to the face and we have defined functions for the same ![layout of cube](resources/Capture.JPG) -## Basic overview of functioning of library +## Basic overview of functioning of library: We are imagining the cube as a `6x3x3 matrix` which hold values according to the above layout -## Using the library functions +## Using the library functions: First we need to create a `6x3x3 matrix` like this : @@ -30,7 +30,7 @@ We can(should) change the values depending on how we have scrambled the cube **To rotate one face clockwise we use the following statement : `face1(&cube[0][0][0], 0)`** // this rotates the face1 clockwise ie. the white face -## List of functions +## List of functions: |function name|work| |----------|---------|