Skip to content

Update README.md #64

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 18 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,96 +1,50 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />


# [Project Name] 🎯
# [PATTICHEE] 🎯


## Basic Details
### Team Name: [Name]
### Team Name: DuoZingo


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Member 1: Neethu Biju - TocH Institute of Science and Technology
- Member 2: Sreelakshmi N - TocH Institute of Science and Technology

### Project Description
[2-3 lines about what your project does]
The "Fake Holiday Calendar" is a fun, interactive, and colorful website designed to prank friends by showing random fake holidays with hilarious pop-up messages. These pop-ups appear when you click on a holiday and disappear automatically after a few seconds, or when you click anywhere on the screen. Along with pranks, the site also lets users set personal reminders, making it a blend of entertainment and utility.

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
Everyone gets bored of the same old boring calendar holidays. Who knew April 12th was “Talk Like a Dinosaur Day”? Nobody! Your friends are missing out on daily doses of random hilarity.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
Fake Holiday Calendar—a colorful, interactive website that pranks your friends with random fake holidays. Click a holiday and enjoy a hilarious pop-up message that disappears after a few seconds. Bonus: you can set personal reminders too, because even pranks need planning.

## 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]

### Implementation
For Software:
# Installation
[commands]

# Run
[commands]
- html
- CSS
- Javascript

### Project Documentation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
<img width="1600" height="702" alt="image" src="https://github.com/user-attachments/assets/9d7c933b-c2aa-4a59-8ada-f487d6526be6" />
It is the first page where we could select months from all months.

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*

<img width="1600" height="687" alt="image" src="https://github.com/user-attachments/assets/e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" />
It is the page with feature for aadding remainder. THat are the only messages that are true.
![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*

For Hardware:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*

![Build](Add photos of build process here)
*Explain the build steps*

![Final](Add photo of final product here)
*Explain the final build*

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*

# Additional Demos
[Add any extra demo materials/links]
<img width="1600" height="698" alt="image" src="https://github.com/user-attachments/assets/bc60a873-6164-4dfc-89e5-8faa8ff7b76e" />
We can share the fake message with friends and prank them .And also we read the meassages send by then.
Comment on lines 34 to +43
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Screenshots section: fix heading level, remove placeholders, correct grammar, and improve alt text

  • Use a consistent heading level (H3 fits the current structure).
  • Remove placeholder image lines.
  • Fix typos/grammar in captions.
  • Make alt text descriptive.
-# Screenshots (Add at least 3)
-<img width="1600" height="702" alt="image" src="https://github.com/user-attachments/assets/9d7c933b-c2aa-4a59-8ada-f487d6526be6" />
-It is the first page where we could select months from all months.
-![Screenshot2](Add screenshot 2 here with proper name)
-<img width="1600" height="687" alt="image" src="https://github.com/user-attachments/assets/e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" />
-It is the page with feature for aadding remainder. THat are the only messages that are true.
-![Screenshot3](Add screenshot 3 here with proper name)
-<img width="1600" height="698" alt="image" src="https://github.com/user-attachments/assets/bc60a873-6164-4dfc-89e5-8faa8ff7b76e" />
-We can share the fake message with friends and prank them .And also we read the meassages send by then.
+### Screenshots
+<img width="1600" height="702" alt="Month selection page" src="https://github.com/user-attachments/assets/9d7c933b-c2aa-4a59-8ada-f487d6526be6" />
+The month selection page.
+
+<img width="1600" height="687" alt="Reminder page" src="https://github.com/user-attachments/assets/e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" />
+This page lets you add reminders. Those are the only messages that are real.
+
+<img width="1600" height="698" alt="Share prank message page" src="https://github.com/user-attachments/assets/bc60a873-6164-4dfc-89e5-8faa8ff7b76e" />
+You can share fake messages with friends to prank them, and also read the messages they send.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
<img width="1600" height="702" alt="image" src="https://github.com/user-attachments/assets/9d7c933b-c2aa-4a59-8ada-f487d6526be6" />
It is the first page where we could select months from all months.
![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
<img width="1600" height="687" alt="image" src="https://github.com/user-attachments/assets/e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" />
It is the page with feature for aadding remainder. THat are the only messages that are true.
![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*
For Hardware:
# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*
# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
![Build](Add photos of build process here)
*Explain the build steps*
![Final](Add photo of final product here)
*Explain the final build*
### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
# Additional Demos
[Add any extra demo materials/links]
<img width="1600" height="698" alt="image" src="https://github.com/user-attachments/assets/bc60a873-6164-4dfc-89e5-8faa8ff7b76e" />
We can share the fake message with friends and prank them .And also we read the meassages send by then.
### Screenshots
<img width="1600" height="702" alt="Month selection page" src="https://github.com/user-attachments/assets/9d7c933b-c2aa-4a59-8ada-f487d6526be6" />
The month selection page.
<img width="1600" height="687" alt="Reminder page" src="https://github.com/user-attachments/assets/e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" />
This page lets you add reminders. Those are the only messages that are real.
<img width="1600" height="698" alt="Share prank message page" src="https://github.com/user-attachments/assets/bc60a873-6164-4dfc-89e5-8faa8ff7b76e" />
You can share fake messages with friends to prank them, and also read the messages they send.
🧰 Tools
🪛 LanguageTool

[grammar] ~38-~38: There might be a mistake here.
Context: ...(Add screenshot 2 here with proper name) <img width="1600" height="687" alt="imag...

(QB_NEW_EN)

[grammar] ~39-~39: There might be a mistake here.
Context: ...e5d2feab-1803-46f2-a8e5-8cfb0ed954dc" /> It is the page with feature for aadding ...

(QB_NEW_EN)

[grammar] ~40-~40: There might be a mistake here.
Context: ...f2-a8e5-8cfb0ed954dc" /> It is the page with feature for aadding remainder. THat are...

(QB_NEW_EN)

[grammar] ~40-~40: There might be a mistake here.
Context: ...Hat are the only messages that are true. ![Screenshot3](Add screenshot 3 here wit...

(QB_NEW_EN)

[style] ~40-~40: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 2049 characters long)
Context: ...at are the only messages that are true. ![Screenshot3](Add screenshot 3 here with...

(EN_EXCESSIVE_EXCLAMATION)

[grammar] ~41-~41: There might be a mistake here.
Context: ...(Add screenshot 3 here with proper name) <img width="1600" height="698" alt="imag...

(QB_NEW_EN)

[grammar] ~42-~42: There might be a mistake here.
Context: ...bc60a873-6164-4dfc-89e5-8faa8ff7b76e" /> We can share the fake message with frien...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In README.md around lines 34 to 43, the Screenshots section uses inconsistent
heading level, contains placeholder image markdown, has poor alt text and
several grammar/typo issues; update the heading to a consistent H3 (###
Screenshots), remove the placeholder lines like "![Screenshot2](Add screenshot 2
here with proper name)" and "![Screenshot3](Add screenshot 3 here with proper
name)", replace each <img .../> HTML tag with a single markdown image line using
a descriptive filename and clear alt text (e.g., "![Month selector screen —
select month]" ), and rewrite the three captions to fix typos and grammar
(concise sentences describing each screenshot: month selection page, add
reminder page, and message sharing/reading page).


## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- Neethu Biju: Frontend and documentation
- Sreelakshmi N: Frontend and documentation

---
Made with ❤️ at TinkerHub Useless Projects
Expand Down