Skip to content

Update Readme.in #39

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 3 commits into
base: main
Choose a base branch
from
Open

Update Readme.in #39

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c50fdaa
Update README.md
SreyaMaxwel Aug 2, 2025
d4e9ba4
Update README.md
SreyaMaxwel Aug 2, 2025
f1ccc6c
Update README.md
SreyaMaxwel Aug 2, 2025
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
57 changes: 30 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />


# [Project Name] 🎯
# [Snack_Spy] 🎯


## Basic Details
### Team Name: [Name]
### Team Name: [The Sleuths]


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: [Sreya Maxwel] - [TKM College of Engineering]
- Member 2: [Shivani S] - [TKM College of Engineering]

### Project Description
[2-3 lines about what your project does]
[This fun computer vision project detects whether food has been fairly split between two people using image analysis. By comparing portion sizes, it helps resolve sibling conflicts over unequal food sharing with a “fairness verdict".]

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
[Siblings everywhere suffer from the age old injustice of one person getting the bigger slice of pizza or cake. These daily food disputes threaten peace at the dinner table. Our project aims to finally bring justice one plate at a time.]

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
[We use computer vision to analyze photos of shared food and calculate how fairly it’s been divided. Whether it’s pizza, cake, or fries , our model snitches on the sibling who took the bigger share and assigns a “Fairness Score.” Because who needs therapy when you have algorithms?]

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
- [Python, HTML, JavaScript, CSS]
- [Flask]
- [rembg,OpenCV,Pillow (PIL),]
- [flask_cors]

For Hardware:
- [List main components]
Expand All @@ -38,23 +37,29 @@ For Hardware:
### Implementation
For Software:
# Installation
[commands]

[pip install flask rembg opencv-python numpy pillow flask-cors]
# Clone the repository
[git clone https://github.com/SreyaMaxwel/Snack_Spy]
# Run
[commands]
[!python app.py]
Comment on lines +40 to +44
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Commands should be in fenced code blocks, not link brackets

Square brackets break rendering and copy-paste. Use fenced blocks and remove the ! prefix on the run command.

-[pip install flask rembg opencv-python numpy pillow flask-cors]
-[git clone https://github.com/SreyaMaxwel/Snack_Spy]
-[!python app.py]
+```bash
+pip install flask rembg opencv-python numpy pillow flask-cors
+
+# Clone the repository
+git clone https://github.com/SreyaMaxwel/Snack_Spy
+
+# Run
+python app.py
+```
🤖 Prompt for AI Agents 
In README.md around lines 40 to 44, the commands are incorrectly enclosed in
square brackets which breaks rendering and copy-paste functionality. Replace the
square brackets with fenced code blocks using triple backticks, remove the
exclamation mark from the python run command, and ensure all commands are
properly formatted inside the fenced block for correct display and usability.


### Project Documentation
For Software:
For Software:This is a fun AI project that detects if food is fairly divided between two people, using image analysis.
Because life isn’t fair… but snacks should be! Built to inject humor and tech into everyday conflicts, Snack Spy turns a common family drama into a gamified AI experience.
How it works:
1.Users upload two food plate images.
2.The backend uses AI (via rembg) to remove image backgrounds.
3.It calculates food area from the foreground in each image using OpenCV.
4.Then it compares the two and returns a similarity score and a cheeky verdict!

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
![Screenshot1](<img width="1915" height="873" alt="image" src="https://github.com/user-attachments/assets/e51936b9-5923-411b-973f-703a40191758" />
)Raw Field

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
![Screenshot2](<img width="1916" height="810" alt="image" src="https://github.com/user-attachments/assets/53c0f0f6-63d5-4d9a-a883-db8c5e95de98" />)Sample Output

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
![Screenshot3](<img width="1901" height="872" alt="image" src="https://github.com/user-attachments/assets/2b08a3f4-f530-4803-9161-0896b59f80b6" />
)Sample UI
Comment on lines +56 to +62
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Screenshot markup is malformed; images won’t render

Wrapping an <img …> tag inside ![…]( … ) is invalid. Choose one style; simplest is regular markdown image:

-![Screenshot1](<img width="1915" height="873" alt="image" src="https://github.com/user-attachments/assets/e51936b9-5923-411b-973f-703a40191758" />
-)Raw Field
+# Raw input
+![Screenshot 1](https://github.com/user-attachments/assets/e51936b9-5923-411b-973f-703a40191758)

Repeat for the remaining screenshots.
This will make the images and captions display properly.

📝 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
![Screenshot1](<img width="1915" height="873" alt="image" src="https://github.com/user-attachments/assets/e51936b9-5923-411b-973f-703a40191758" />
)Raw Field
![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
![Screenshot2](<img width="1916" height="810" alt="image" src="https://github.com/user-attachments/assets/53c0f0f6-63d5-4d9a-a883-db8c5e95de98" />)Sample Output
![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
![Screenshot3](<img width="1901" height="872" alt="image" src="https://github.com/user-attachments/assets/2b08a3f4-f530-4803-9161-0896b59f80b6" />
)Sample UI
# Raw input
![Screenshot 1](https://github.com/user-attachments/assets/e51936b9-5923-411b-973f-703a40191758)
![Screenshot2](<img width="1916" height="810" alt="image" src="https://github.com/user-attachments/assets/53c0f0f6-63d5-4d9a-a883-db8c5e95de98" />)Sample Output
![Screenshot3](<img width="1901" height="872" alt="image" src="https://github.com/user-attachments/assets/2b08a3f4-f530-4803-9161-0896b59f80b6" />
)Sample UI
🤖 Prompt for AI Agents 
In README.md around lines 56 to 62, the screenshot images are incorrectly
embedded by wrapping HTML <img> tags inside markdown image syntax, which
prevents them from rendering. Fix this by removing the markdown image syntax and
using only the HTML <img> tags with appropriate attributes, or alternatively,
replace the HTML tags with proper markdown image syntax using the image URLs
directly. Apply this correction consistently to all three screenshots to ensure
they display properly with captions.


# Diagrams
![Workflow](Add your workflow/architecture diagram here)
Expand All @@ -81,16 +86,14 @@ For Hardware:

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
[[Add your demo video link here](https://drive.google.com/file/d/1YCf2REIiPtGIjV3dnv20B3zQWKeTTyQg/view?usp=drive_link)]

# Additional Demos
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- [Shivani S]: [Front End Design and Development ,Final degugging]
- [Sreya Maxwel]: [Backend Development,Complete Integration]

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