|
| 1 | +<h1 align="center"> |
| 2 | + <a href="https://github.com/CommunityOfCoders/Inheritance-2022"> |
| 3 | + <img src="https://res.cloudinary.com/dn6vz8exv/image/upload/v1665664791/inh_zzefoy.jpg" alt="CoC Inheritance 2022" width="500" height="166"> |
| 4 | + </a> |
| 5 | + <br> |
| 6 | + Project Name |
| 7 | +</h1> |
| 8 | + |
| 9 | +<div align="center"> |
| 10 | + <strong>Project Name</strong> - One Sentence Description of your project<br> |
| 11 | + CoC Inheritance 2022 || Team Name <br> <br> |
| 12 | + Add any <a href="https://shields.io/">Shields</a> here |
| 13 | +</div> |
| 14 | +<hr> |
| 15 | + |
| 16 | +<details> |
| 17 | +<summary>Table of Contents</summary> |
| 18 | + |
| 19 | +- [Description](#description) |
| 20 | +- [Links](#links) |
| 21 | +- [Tech Stack](#tech-stack) |
| 22 | +- [Progress](#progress) |
| 23 | +- [Future Scope](#future-scope) |
| 24 | +- [Applications](#applications) |
| 25 | +- [Project Setup](#project-setup) |
| 26 | +- [Usage](#usage) |
| 27 | +- [Team Members](#team-members) |
| 28 | +- [Mentors](#mentors) |
| 29 | +- [Screenshots](#screenshots) |
| 30 | + |
| 31 | +</details> |
| 32 | + |
| 33 | +## 📝Description |
| 34 | + |
| 35 | +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. |
| 36 | + |
| 37 | +1. Include features and their usecases in bullet points |
| 38 | + |
| 39 | +## 🔗Links |
| 40 | + |
| 41 | +- [GitHub Repository]() |
| 42 | +- [Demo Video]() |
| 43 | +- [Drive Link to Screenshots of your project]() |
| 44 | +- [Hosted Website Link]() |
| 45 | +- [App APK Link]() |
| 46 | +- [Hosted Backend Link]() |
| 47 | + |
| 48 | +Add any more links/resources you used for your project |
| 49 | + |
| 50 | +## 🤖Tech-Stack |
| 51 | + |
| 52 | +Mention all languages/libraries/frameworks used in your project **domain-wise** |
| 53 | +You can use icons too - find them [here](https://github.com/get-icon/geticon) |
| 54 | + |
| 55 | +#### Front-end |
| 56 | +- HTML |
| 57 | +- CSS |
| 58 | +- JavaScript |
| 59 | +- etc. |
| 60 | + |
| 61 | +#### Back-end |
| 62 | +- NodeJS |
| 63 | +- ExpressJS |
| 64 | +- etc. |
| 65 | + |
| 66 | +#### Database |
| 67 | +- MongoDB |
| 68 | +- SQL |
| 69 | +- etc. |
| 70 | + |
| 71 | +#### Computer Vision |
| 72 | +- OpenCV |
| 73 | +- etc. |
| 74 | + |
| 75 | +## 📈Progress |
| 76 | + |
| 77 | +List down all the fully implemented features in your project |
| 78 | + |
| 79 | +- [x] Fully Implemented Feature 1 |
| 80 | +- [x] Fully Implemented Feature 2 |
| 81 | + |
| 82 | +List down all the partially implemented features in your project |
| 83 | + |
| 84 | +- [ ] Partially Implemented Feature 1 |
| 85 | +- [ ] Partially Implemented Feature 2 |
| 86 | + |
| 87 | +## 🔮Future Scope |
| 88 | + |
| 89 | +List down all the future plans for the project here |
| 90 | + |
| 91 | +- Future Feature 1 |
| 92 | +- Future Feature 2 |
| 93 | + |
| 94 | +## 💸Applications |
| 95 | + |
| 96 | +>How can your project do its part in solving a real-life problem? What are its possible applications? Can it be monetized? Describe here. |
| 97 | +
|
| 98 | +## 🛠Project Setup |
| 99 | + |
| 100 | +>Include your project setup basics here. Steps for how someone else can setup your project on their machine. Add any relevant details as well. |
| 101 | +
|
| 102 | +## 💻Usage |
| 103 | + |
| 104 | +>Steps to run your project once its setup. If you have an app or website, list how the user can go about using it. |
| 105 | +
|
| 106 | +## 👨💻Team Members |
| 107 | + |
| 108 | +Add names of your team members with their emails and links to their GitHub accounts |
| 109 | + |
| 110 | +- [Team Member 1 Name](https://github.com/): Email |
| 111 | +- [Team Member 2 Name](https://github.com/): Email |
| 112 | + |
| 113 | +## 👨🏫Mentors |
| 114 | + |
| 115 | +Add names of your mentors with their emails and links to their GitHub accounts |
| 116 | + |
| 117 | +- [Mentor 1 Name](https://github.com/): Email |
| 118 | +- [Mentor 2 Name](https://github.com/): Email |
| 119 | + |
| 120 | +## 📱Screenshots |
| 121 | +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. |
| 122 | + |
| 123 | +You'll have to link the screenshots from your drive folder here. |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | +Use this template as a guide for writing your documentation. Feel free to customize and adapt it for you project. |
| 128 | +For more Markdown syntax help, visit [here](https://www.markdownguide.org/basic-syntax/) |
0 commit comments