diff --git a/README.md b/README.md index 550645d..6070a91 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ +# Rubik-Cube + #
✨Rubik-Cube✨
+- - + @@ -18,10 +20,92 @@
+ + +## 🌐 Link to Game Demo +https://dev-tanay.github.io/Rubik-Cube/ + + + +## 📖 About the Game +This is a simple and elegant game where you can play Rubik's Cube from your own web browser. + +- Each of the six faces of the Rubik's cube is in one of the six colors - red, green, yellow, blue, white, and orange. +- The visible part of the cube is divided into 26 pieces: + - 6 central pieces (one colored side) + - 12 edge pieces (two colored sides) + - 8 corner pieces (three colored sides) +- The 26 pieces are "scrambled" to have different colors on each face. + +## 🕹️ How to Play +The objective of this game is to get each face of the cube to have a single color. + +This can be done in two ways: + +1. **Twisting the Segments** + - This can be done by dragging the cursor over the segment you want to rotate. + + + +2. **Changing the View of the Cube** + - This can be done by dragging the cursor in an arrow around the cube. + + +## 🧩 Installation Guide for Rubik-Cube + +Follow the steps below to install and set up the Rubik-Cube project on your local machine. + +### 📋 Prerequisites +- Ensure you have `git` installed on your system. If not, download and install it from [here](https://git-scm.com/). +- A modern web browser (e.g., Chrome, Firefox, Edge). + +### 🛠️ Steps + +1. **🔗 Clone the Repository** + Open your terminal (or Command Prompt on Windows) and run the following command to clone the repository: + ```sh + git clone https://github.com/Dev-tanay/Rubik-Cube.git + ``` + +2. **📂 Navigate to the Cloned Repository** + Change directory to the cloned repository: + ```sh + cd Rubik-Cube + ``` + +3. **🌐 Open the Index.html File** + Locate the `index.html` file in the repository and open it in your web browser. You can do this by either: + - **Double-clicking the `index.html` file** in your file manager. This will open the file in your default web browser. + - **Running a simple HTTP server** (if you prefer): + + **Using Python (if installed):** + ```sh + python -m http.server + ``` + Open your web browser and go to `http://localhost:8000`. + + **Using Node.js (if installed) with http-server package:** + ```sh + npx http-server + ``` + Open your web browser and go to the provided local server URL (usually `http://127.0.0.1:8080` or similar). + +4. **🎮 Play the Game** + Once the `index.html` file is opened in the web browser, the game screen will be displayed. You can now start playing the Rubik-Cube game. + +### ℹ️ Notes +- Ensure your browser allows running JavaScript, as the game likely depends on it. +- If you encounter any issues, check the browser console for error messages and ensure all assets are properly loaded. + +Enjoy your Rubik-Cube game! 🕹️✨ + +## 🧭 Navigating the Game Screen +- **Home** +This is a simple and elegant game where you can play Rubik's Cube from your own web browser.
Each of the six faces of the Rubik's cube is in one of the six colors - red, green, yellow, blue, white, and orange.
@@ -83,38 +167,38 @@You'll see two icons, each on the two bottom corners of the screen. They're (1) Leaderboard and (2) Preferences.
-You can start the game by double-clicking on the text "DOUBLE TAP TO START"
-Once you start the game, a timer will show above the cube.
-Now you'll see only one icon, that is Back.
-On clicking Preferences from Home screen, you'll be led to the settings page.
-The options you can change here are:
-Also, there are two new icons in the bottom corners - (3) Back and (4) Theme.
-Here, you can adjust the hue, saturation, and lightness of the screen to your liking.
-The new icons in the bottom corners are - (5) Back and (6) Reset.
-These display the statistics of your Rubik's Cube game. The stats include:
-This project is licensed under the MIT License - see the LICENSE file for details.
+## 📜 License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file