Skip to content

README.md

Latest commit

 

History

History
55 lines (34 loc) · 1.73 KB

README.md

File metadata and controls

55 lines (34 loc) · 1.73 KB

Rubik’s Cube Project

Welcome!
This project brings together everything you need to explore, solve, and understand the Rubik’s Cube—from algorithms and AI to math and visualizations.

Project Structure

Here’s what you’ll find inside:

  • cube/
    The foundation. Handles the cube’s structure, labels, and all core logic.

  • algo/
    A collection of different algorithmic approaches to solving the cube, each in its own sub-package.

  • ai/
    Machine learning and data-driven methods for cube solving.

  • designs/
    Visualizations and animations showing the cube being solved—currently terminal-based, but open to all creative ideas.

  • group_theory/
    Dive into the math behind the cube: permutations, cycles, and group theory concepts.

Explore Further

Each sub-package comes with its own README.md and CONTRIBUTING.md files for detailed info and contribution guidelines.
Check those out for specifics on how each part works and how you can get involved!

How to Get Started

  • Browse the folders for details and documentation.
  • Try running visualizations from the terminal (see designs/README.md for examples).
  • Experiment with algorithms, AI, or mathematical concepts.
  • Contribute your own ideas, improvements, or features!

Want to Contribute?

We welcome all contributions—code, designs, documentation, theory, or anything creative!
For general guidelines, see the CONTRIBUTING.md file, and check individual sub-packages for more specific instructions.

We don't want perfection but your brilliant ideas to flow in this repository.

Thanks for checking out the project.
Happy coding, cubing, and creating! 🧩