31 lines
809 B
Markdown

\mainpage Roboid Control for Python
Roboid Control support for Python applications
Supporting:
- Windows
- MacOS
- Linux
# Install
You can install the package directly from the git server using pip:
```
pip install git+https://git.passer.life/RoboidControl/RoboidControl-python.git
```
If you want to use a specific branch, you can use
```
pip install git+https://git.passer.life/RoboidControl/RoboidControl-python.git@v0.4_dev
```
Alternatively you can clone the repo to a folder in you project.
Then you can install it by going to the root folder of the repository (the folder containing this `README.md` and `setup.py`)
and execute the command.
```
pip install .
```
# Basic components
- \ref RoboidControl::Thing::Thing "Thing"
- \ref RoboidControl::ParticipantUDP::ParticipantUDP "ParticipantUDP"