Skip to content

Commit ff954a0

Browse files
Added and enhanced README files for 5 projects
Added README files for - 2048 game, 3D car racing game, 3D Distance calculator & A-Z english learning. Enhanced README of 8-puzzle
1 parent a0c86b1 commit ff954a0

File tree

5 files changed

+175
-3
lines changed

5 files changed

+175
-3
lines changed

2048 Game/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Number-Box 2048 Game
2+
The game is built using HTML, CSS, and JavaScript, and allows users to play the popular 2048 game with various grid sizes.
3+
4+
## Table of Contents
5+
* Game Overview
6+
* Features
7+
* Usage
8+
* Project Structure
9+
10+
## Game Overview
11+
The "Number-Box" 2048 game allows players to choose the grid size and use arrow keys to play the game. The goal is to combine numbers to reach the 2048 tile.
12+
13+
## Features
14+
* Choose grid size: 4x4, 5x5, 6x6, or 7x7
15+
* Use arrow keys to move tiles
16+
* Undo functionality
17+
* Animated snowflakes as a visual effect
18+
19+
## Usage
20+
* Open the 2048-game.html file in your web browser.
21+
* Choose the grid size by clicking the buttons (4, 5, 6, or 7).
22+
* Use the arrow keys to move the tiles and combine them to reach 2048.
23+
* Click the undo button to undo the last move.
24+
25+
## Project Structure
26+
27+
```rust
28+
number-box-2048/
29+
├── css/
30+
│ └── style.css
31+
├── js/
32+
│ ├── jquery.js
33+
│ └── number-box.js
34+
├── 2048-game.html
35+
└── README.md
36+
```
37+
38+
* 2048-game.html: The main HTML file for the game.
39+
* css/style.css: The CSS file for styling the game.
40+
* js/jquery.js: The jQuery library.
41+
* js/number-box.js: The JavaScript file containing the game logic.

3D Car Racing Game/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# 3D Car Racing Game
2+
The game features an engaging 3D racing experience with dynamic controls and an immersive environment. It includes features such as real-time scoring, a user interface (HUD), and various control options.
3+
4+
## Table of Contents
5+
* Game Overview
6+
* Features
7+
* Usage
8+
* Project Structure
9+
10+
## Game Overview
11+
The 3D Car Racing Game offers a thrilling racing experience with a visually engaging 3D environment. Players can control their car, track their score and time, and navigate through various racing challenges. The game includes a user-friendly interface with real-time updates on score, time, and laps.
12+
13+
## Features
14+
* 3D Racing Environment: Navigate through a dynamic and immersive racing track.
15+
* Real-time HUD: Displays time, score, lap count, and tachometer readings.
16+
* Interactive Controls: Insert coin, mute, move, and accelerate using intuitive controls.
17+
* Highscore Tracking: Keeps track of high scores for competitive play.
18+
19+
## Usage
20+
1. Open the index.html file in your web browser.
21+
2. Use the following controls:
22+
C: Insert coin
23+
M: Mute
24+
< >: Move
25+
< >: Accelerate
26+
3. The HUD will display real-time updates on your score, time, and lap count.
27+
4. Enjoy the racing experience and try to achieve the highest score!
28+
29+
## Project Structure
30+
31+
```bash
32+
3d-car-racing-game/
33+
├── javascript/
34+
│ ├── 1.js
35+
│ ├── script.js
36+
│ └── null.js
37+
├── src/
38+
│ └── style.css
39+
├── icon.png
40+
├── index.html
41+
└── README.md
42+
```
43+
44+
* index.html: The main HTML file for the game.
45+
* javascript/1.js: JavaScript file containing game logic or additional features.
46+
* javascript/script.js: Main JavaScript file for game functionality.
47+
* javascript/null.js: Additional JavaScript file (possibly empty or placeholder).
48+
* src/style.css: CSS file for styling the game.
49+
* icon.png: Favicon for the game.

3D distance calculator/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 3D Distance Calculator
2+
The tool calculates the distance between two points in a 3D space based on user input. It provides a simple interface for entering the coordinates of two points and calculates the distance when a button is clicked.
3+
4+
## Table of Contents
5+
* Project Overview
6+
* Features
7+
* Usage
8+
* Project Structure
9+
10+
## Project Overview
11+
The 3D Distance Calculator is a straightforward tool designed to compute the Euclidean distance between two points in a 3D coordinate system. Users can input the coordinates of two points, and the distance is calculated and displayed upon clicking a button.
12+
13+
## Features
14+
* User Input: Input fields for coordinates of two points in 3D space.
15+
* Distance Calculation: Computes the distance using the Euclidean distance formula.
16+
* Results Display: Displays the calculated distance on the screen.
17+
18+
## Usage
19+
1. Open the index.html file in your web browser.
20+
2. Enter the coordinates of Point 1 (x1, y1, z1) in the first input field.
21+
3. Enter the coordinates of Point 2 (x2, y2, z2) in the second input field.
22+
4. Click the "Calculate" button to compute the distance.
23+
5. The calculated distance will be displayed below the button.
24+
25+
## Project Structure
26+
27+
```bash
28+
3d-distance-calculator/
29+
├── style.css
30+
├── script.js
31+
├── index.html
32+
└── README.md
33+
```
34+
35+
* index.html: The main HTML file for the Distance Calculator.
36+
* style.css: CSS file for styling the calculator.
37+
* script.js: JavaScript file containing the logic for calculating the distance.
38+
* README.md: This README file.

8 Puzzle/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
An interactive 8-puzzle game built with HTML, CSS, and JavaScript. The objective of the game is to arrange the tiles in numerical order by sliding them into the empty space.
44

55
## Features
6-
- Shuffle the puzzle tiles.
7-
- Reset the puzzle to the solved state.
8-
- Timer to track the time taken to solve the puzzle.
6+
- Puzzle Grid: A 3x3 grid with tiles that can be moved to solve the puzzle.
7+
- Shuffle Button: Randomly shuffles the tiles to create a new puzzle.
8+
- Reset Button: Resets the puzzle to its initial solved state.
9+
- Timer: Displays the elapsed time since the puzzle was started.
910

1011
## How to Play
1112

@@ -37,6 +38,14 @@ An interactive 8-puzzle game built with HTML, CSS, and JavaScript. The objective
3738

3839
## Code Structure
3940

41+
```bash
42+
8-puzzle-game/
43+
├── style.css
44+
├── script.js
45+
├── index.html
46+
└── README.md
47+
```
48+
4049
### HTML
4150

4251
The HTML file sets up the structure of the game with a container for the puzzle and buttons for shuffling and resetting the tiles.

A-Z English Learning/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# A-Z Learning
2+
This simple web application helps users learn the English alphabet by clicking on each letter to interact with it. The app is designed to be engaging and educational for users of all ages.
3+
4+
## Table of Contents
5+
* Project Overview
6+
* Features
7+
* Usage
8+
* Project Structure
9+
10+
## Project Overview
11+
The A-Z Learning application is a straightforward educational tool where users can click on buttons representing each letter of the English alphabet. Each button can be styled or programmed to provide interactive feedback, such as displaying the letter's name or playing a sound.
12+
13+
## Features
14+
* Interactive Buttons: Buttons for each letter of the English alphabet from A to Z.
15+
* Custom Styling: Customizable appearance using CSS.
16+
* Responsive Design: Designed to work on various devices.
17+
18+
## Usage
19+
1. Open the index.html file in your web browser.
20+
2. Click on the alphabet buttons (A-Z) to interact with them. Each button can be customized to perform specific actions, such as displaying information about the letter.
21+
22+
## Project Structure
23+
24+
```bash
25+
a-z-learning/
26+
├── popup.css
27+
├── popup.js
28+
├── index.html
29+
└── README.md
30+
```
31+
32+
* index.html: The main HTML file for the A-Z Learning application.
33+
* popup.css: CSS file for styling the alphabet buttons and layout.
34+
* popup.js: JavaScript file for adding interactivity to the alphabet buttons.
35+
* README.md: This README file.

0 commit comments

Comments
 (0)