Start

Author: LindomarRodrigues

LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1 +1,86 @@
-# MagicCube
+# MagicCube
+
+Python 3 implementation of a (3x3x3) Rubik's Cube utility.
+
+![3x3x3 Rubik's Cube](cube.png)
+
+## Installation
+
+Clone the repository and navigate to the project directory:
+
+```bash
+git clone <repo_url>
+cd rubiks-cube
+```
+
+Install the required packages:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+To use the utility, import the `Cube` class from the `cube` module:
+
+```python
+from cube import Cube
+```
+
+Create a new instance of the `Cube` class:
+
+```python
+cube = Cube()
+```
+
+Print or plot the cube:
+
+```python
+cube.pprint()
+
+# or
+
+cube.plot()
+```
+
+Perform a sequence of moves:
+
+```python
+cube.move("R U R' U'")
+```
+
+Solver the cube using Layer by Layer (LBL) method:
+
+```python
+from solvers.layer_by_layer import LayerByLayerSolver
+
+solver = LayerByLayerSolver(cube)
+solver.solve()
+
+print(solver.moves)
+```
+
+Optimize the sequence of moves:
+
+```python
+from solvers.optimizer import optimize_moves
+
+print(len(moves))
+moves = optimize_moves(moves)
+print(len(moves))
+```
+
+## Misc
+
+To use a custom VisualCube server, set the `VISUAL_CUBE_HOST` environment variable:
+
+```bash
+export VISUAL_CUBE_HOST="http://localhost:80"
+```
+
+
+
+
+
+
+