-
Notifications
You must be signed in to change notification settings - Fork 886
Update README.md #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update README.md #36
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,96 +1,151 @@ | ||
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" /> | ||
|
||
|
||
# [Project Name] 🎯 | ||
git clone: | ||
https://github.com/zamaan-nalakath/Too-many-buttons | ||
# Too Many Buttons 🎯 | ||
|
||
|
||
## Basic Details | ||
### Team Name: [Name] | ||
### Individual : Zamaan Nalakath | ||
|
||
### Project Description | ||
Too Many Buttons is a completely unnecessary game designed to waste your time in the most entertaining way possible. You’re presented with 100 blank buttons. One of them says “Win.” But you don’t know which one. Every click reshuffles the entire board. You might win. But probably not. | ||
|
||
### Team Members | ||
- Team Lead: [Name] - [College] | ||
- Member 2: [Name] - [College] | ||
- Member 3: [Name] - [College] | ||
Like Minesweeper, but with no logic. | ||
Like life, but with more buttons. | ||
|
||
### Project Description | ||
[2-3 lines about what your project does] | ||
|
||
### The Problem (that doesn't exist) | ||
[What ridiculous problem are you solving?] | ||
There are too many buttons in life. | ||
So we made a game with even more — | ||
100+ identical ones, | ||
and only one works. | ||
|
||
Nobody needed this. | ||
But we built it anyway. | ||
|
||
### The Solution (that nobody asked for) | ||
[How are you solving it? Keep it fun!] | ||
When faced with too many meaningless options, | ||
we added more. | ||
And called it a game. | ||
|
||
|
||
## Technical Details | ||
### Technologies/Components Used | ||
For Software: | ||
- [Languages used] | ||
- [Frameworks used] | ||
- [Libraries used] | ||
- [Tools used] | ||
|
||
For Hardware: | ||
- [List main components] | ||
- [List specifications] | ||
- [List tools required] | ||
- HTML,CSS,Java Script | ||
|
||
### Implementation | ||
|
||
For Software: | ||
|
||
Frontend Only: | ||
This project is built entirely with HTML, CSS, and vanilla JavaScript — no frameworks, no libraries, no backend. | ||
|
||
Core Logic: | ||
Create 100+ identical buttons dynamically | ||
Randomly assign one hidden “Win” button | ||
|
||
On every click: | ||
Display a message (win or lose) | ||
Shuffle all buttons with a fade-out/fade-in animation | ||
Track total time since the game started | ||
|
||
Design Choices: | ||
Buttons have no labels (pure guessing) | ||
Shuffle is visible for psychological damage | ||
UI is minimalist and slightly hostile | ||
|
||
Files: | ||
index.html – Structure | ||
style.css – Visual pain | ||
script.js – Game logic and timer | ||
|
||
# Installation | ||
[commands] | ||
|
||
git clone https://github.com/your-username/too-many-buttons.git | ||
cd too-many-buttons | ||
|
||
|
||
# Run | ||
[commands] | ||
# Option 1: Open directly | ||
open index.html # macOS / Linux | ||
start index.html # Windows | ||
|
||
|
||
### Project Documentation | ||
For Software: | ||
|
||
# Screenshots (Add at least 3) | ||
 | ||
*Add caption explaining what this shows* | ||
--- | ||
Comment on lines
76
to
+78
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Fix heading-level skip: “Project Documentation” should be H2, not H3 After an H1 (# Run) the next heading appears as H3: ### Project Documentation This skips the H2 level and triggers MD001. -### Project Documentation
+## Project Documentation 🧰 Tools🪛 markdownlint-cli2 (0.17.2)75-75: Heading levels should only increment by one level at a time (MD001, heading-increment) 🤖 Prompt for AI Agents
|
||
|
||
 | ||
*Add caption explaining what this shows* | ||
## 🤯 Too Many Buttons | ||
|
||
 | ||
*Add caption explaining what this shows* | ||
A ridiculous guessing game with 100+ identical blank buttons. | ||
Only one wins. They shuffle every time. It’s painful. It’s perfect. | ||
|
||
--- | ||
|
||
# Diagrams | ||
 | ||
*Add caption explaining your workflow* | ||
### 🔧 Tech Stack | ||
|
||
For Hardware: | ||
* HTML | ||
* CSS | ||
* JavaScript (Vanilla) | ||
|
||
--- | ||
|
||
### 🧠 Concept | ||
|
||
* 100+ buttons | ||
* One secretly says “Win” | ||
* Click = Shuffle | ||
* You can win, but probably won’t | ||
* Includes timer to track your suffering | ||
|
||
--- | ||
|
||
### 🚀 Installation | ||
|
||
``` | ||
git clone https://github.com/your-username/too-many-buttons.git | ||
cd too-many-buttons | ||
``` | ||
|
||
--- | ||
|
||
### ▶️ Run | ||
|
||
``` | ||
# Option 1 | ||
open index.html # macOS / Linux | ||
start index.html # Windows | ||
|
||
# Option 2 (recommended) | ||
npx serve | ||
# OR | ||
python -m http.server | ||
``` | ||
|
||
--- | ||
--- | ||
|
||
|
||
|
||
# Screenshots (Add at least 3) | ||
<img width="1874" height="819" alt="image" src="https://github.com/user-attachments/assets/f2df7b7f-0efc-41e3-a4ca-d3c25279d989" /> | ||
|
||
# Schematic & Circuit | ||
 | ||
*Add caption explaining connections* | ||
Webpage | ||
|
||
 | ||
*Add caption explaining the schematic* | ||
<img width="1052" height="847" alt="image" src="https://github.com/user-attachments/assets/1a5e0b27-58c1-43f2-a1c7-8aa065dc2afd" /> | ||
|
||
# Build Photos | ||
 | ||
*List out all components shown* | ||
|
||
 | ||
*Explain the build steps* | ||
On clicking a wrong file, the tiles re shuffle. and shows "nope try again" | ||
|
||
 | ||
*Explain the final build* | ||
<img width="1086" height="844" alt="image" src="https://github.com/user-attachments/assets/b6bb3e8d-0bcf-41c6-a8df-dab625d86e56" /> | ||
On clicking correct one, it shows "You won" | ||
|
||
### Project Demo | ||
# Video | ||
[Add your demo video link here] | ||
*Explain what the video demonstrates* | ||
|
||
# Additional Demos | ||
[Add any extra demo materials/links] | ||
|
||
## Team Contributions | ||
- [Name 1]: [Specific contributions] | ||
- [Name 2]: [Specific contributions] | ||
- [Name 3]: [Specific contributions] | ||
Zamaan Nalakath - Everything. | ||
|
||
--- | ||
Made with ❤️ at TinkerHub Useless Projects | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Avoid multiple top-level (
#
) headings; demote “Installation” and “Run” to##
Markdown style guides (incl. GitHub’s) recommend having a single H1 per document for accessibility and to preserve a clear outline.
Lines 63 and 69 introduce second and third H1s:
Please change these to
## Installation
/## Run
(or nest under an existing section) to maintain a proper heading hierarchy.This will also eliminate the MD001 heading-increment warning.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents