diff --git a/README.md b/README.md index b2c8d15..73c8e1d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,39 @@ -# TI-project - Kobuki +# TI-project - exploration robot Kobuki ## Description -This project is a kobuki that drives around in dangerous areas and detects objects in its path. It uses a camera to detect objects. The kobuki is able to drive around in a room and detect objects. +This project is a kobuki that drives around in dangerous areas and detects objects in its path. It uses a camera to detect objects. The purpose of this project is to explore dangerous areas without risking human lives. You are able to control the robot using controller on the website. ## Photos ![Kobuki](/docs/assets/KobukiPhoto.jpg) +## Installation + +### Requirements + +- Kobuki robot +- Raspberry Pi (minimum 3B) +- Camera +- power supply for Raspberry Pi +- laptop or computer + +### Steps + +1. **Install Python and Pip** + - Ensure you have Python installed on your system. You can download it from [python.org](https://www.python.org/). + - Pip is the package installer for Python. It usually comes with Python, but you can install it separately if needed. + +2. **Clone Our Repository** + - Clone our repository to your local machine doing the following : + - Open your terminal + - Change the current working directory to the location where you want the cloned directory. + - Type `git clone https://gitlab.fdmci.hva.nl/technische-informatica-sm3/ti-projectten/rooziinuubii79.git + +3. **Install the required packages** + - Open the terminal and navigate to the project - scr - Python - flask. + - Run the following command to install the required packages: + - `pip install -r requirements.txt` + - This will install all the python packages required to run the project. + - for C++, you will need to install the following packages: + - OpenCV + - mqtt-client +4. \ No newline at end of file