sample_readme.md

Project Name

Project Name - One Sentence Description of your project
CoC Inheritance 2022 || Team Name

Add any Shields here

---

Table of Contents

• Description
• Links
• Tech Stack
• Progress
• Future Scope
• Applications
• Project Setup
• Usage
• Team Members
• Mentors
• Screenshots

📝Description

Add your project description here. Your project description should cover how your website/app works. That way you can convey what your project is without the need for anyone to view the code. A more detailed README in your project repository is encouraged, which can include build and use instructions etc.

1. Include features and their usecases in bullet points

🔗Links

• GitHub Repository
• Demo Video
• Drive Link to Screenshots of your project
• Hosted Website Link
• App APK Link
• Hosted Backend Link

Add any more links/resources you used for your project

🤖Tech-Stack

Mention all languages/libraries/frameworks used in your project domain-wise
You can use icons too - find them here

Front-end

• HTML
• CSS
• JavaScript
• etc.

Back-end

• NodeJS
• ExpressJS
• etc.

Database

• MongoDB
• SQL
• etc.

Computer Vision

• OpenCV
• etc.

📈Progress

List down all the fully implemented features in your project

• Fully Implemented Feature 1
• Fully Implemented Feature 2

List down all the partially implemented features in your project

• Partially Implemented Feature 1
• Partially Implemented Feature 2

🔮Future Scope

List down all the future plans for the project here

• Future Feature 1
• Future Feature 2

💸Applications

How can your project do its part in solving a real-life problem? What are its possible applications? Can it be monetized? Describe here.

🛠Project Setup

Include your project setup basics here. Steps for how someone else can setup your project on their machine. Add any relevant details as well.

💻Usage

Steps to run your project once its setup. If you have an app or website, list how the user can go about using it.

👨‍💻Team Members

Add names of your team members with their emails and links to their GitHub accounts

• Team Member 1 Name: Email
• Team Member 2 Name: Email

👨‍🏫Mentors

Add names of your mentors with their emails and links to their GitHub accounts

• Mentor 1 Name: Email
• Mentor 2 Name: Email

📱Screenshots

Add a few screenshots for parts of the project completed till now to give the viewer a quick idea of what your project looks like. After all, a picture speaks a thousand words.

You'll have to link the screenshots from your drive folder here.

Use this template as a guide for writing your documentation. Feel free to customize and adapt it for you project.
For more Markdown syntax help, visit here