Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 995 Bytes

File metadata and controls

33 lines (25 loc) · 995 Bytes

Template Example Project

Create a README.md file in your project directory. This file should include:

Overview

A summary of your project.

Video

Add a video link from YouTube with a brief description of what the video demonstrates - for example: Watch the demo on YouTube

Versions

Specify the versions of Hailo examples you verified the software with.

Setup Instructions

How to install dependencies and run the project - for example:

Run the following commands:

pip install -r requirements.txt
./download_resources.sh

Usage

Examples of how to run the script - for example:

Basic usage:

python template_example.py

A good README ensures that others can understand and use your project. If needed, you can add additional sections or links to external documentation. For example Thingiverse, Instructables, or other resources that can help users understand your project.