If you are not familiar with writing readme refer this.

Don't include this line in readme :smiley:

Project Title

One Line description of project goes here

<!-- TABLE OF CONTENTS -->

Table of Contents

• About the Project
  • Tech Stack
  • File Structure
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Results and Demo
• Future Work
• Troubleshooting
• Contributors
• Acknowledgements and Resources
• License

<!-- ABOUT THE PROJECT -->

About The Project

![Product Name Screen Shot][product-screenshot]

Aim and Description of project.
Refer this documentation

Tech Stack

This section should list the technologies you used for this project. Leave any add-ons/plugins for the prerequisite section. Here are a few examples.

• Coppeliasim
• OpenCV
• ROS

File Structure

.
├── app.py                  # Explain the function preformed by this file in short
├── docs                    # Documentation files (alternatively `doc`)
│   ├── report.pdf          # Project report
│   └── results             # Folder containing screenshots, gifs, videos of results
├── src                     # Source files (alternatively `lib` or `app`)
├── ...
├── test                    # Test files (alternatively `spec` or `tests`)
│   ├── benchmarks          # Load and stress tests
│   ├── integration         # End-to-end, integration tests (alternatively `e2e`)
│   └── unit                # Unit tests
├── ...
├── tools                   # Tools and utilities
├── LICENSE
├── README.md 
├── Setup.md                # If Installation instructions are lengthy
└── todo.md                 # If Future developments and current status gets lengthy

<!-- GETTING STARTED -->

Getting Started

Prerequisites

• See SETUP.md if there are plenty of instructions
• List of softwares with version tested on

How to install them

• ESP-IDF v4.0 and above

  You can visit the ESP-IDF Programmming Guide for the installation steps.

• See if you can make requirements.txt

pip install -r "requirements.txt"

Installation

1. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

<!-- USAGE EXAMPLES -->

Usage

How to run the driver code

<!-- RESULTS AND DEMO -->

Results and Demo

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space.
result screenshots

| Use | Table | |:----:|:-------:| | For | Comparison|

<!-- FUTURE WORK -->

Future Work

• See todo.md for seeing developments of this project

• [x] Task 1
• [x] Task 2
• [ ] Task 3
• [ ] Task 4

<!-- TROUBLESHOOTING -->

Troubleshooting

• Common errors while configuring the project

<!-- CONTRIBUTORS -->

Contributors

• Member Name
• Member Name

<!-- ACKNOWLEDGEMENTS AND REFERENCES -->

Acknowledgements and Resources

• SRA VJTI Eklavya 2020
• Refered this for achieving this
  ...

<!-- LICENSE -->

License

Describe your License for your project.