Skip to content
Snippets Groups Projects
Commit 5c51e803 authored by Felix Agner's avatar Felix Agner
Browse files

small readme changes and changed the project name in the toml

parent 0442fb00
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## Description ## Description
This is a python package which allows connection (currently only TCP-based) with the omnibots at the Department of Automatic Control. This is a python package which allows connection (currently only TCP-based) with the omnibots at the Department of Automatic Control.
Note that this package convers the **client side**. For information about setting up the omnibot, see (link here). Note that this package covers the *client side*. For information about setting up the omnibot, see (link here).
## Installation ## Installation
On linux: On linux:
...@@ -18,7 +18,7 @@ To read positions from the crazyflie, use ...@@ -18,7 +18,7 @@ To read positions from the crazyflie, use
`z = bot.get_z()`, `z = bot.get_z()`,
`theta = bot.get_theta()`. `theta = bot.get_theta()`.
*Example:* **Example:**
Connect to a robot at localhost, make it spin in a circle and read the x and y positions. Connect to a robot at localhost, make it spin in a circle and read the x and y positions.
``` ```
from omnibot.tcp import Connection from omnibot.tcp import Connection
...@@ -46,7 +46,7 @@ with Connection(HOST) as bot: ...@@ -46,7 +46,7 @@ with Connection(HOST) as bot:
sleep(0.1) sleep(0.1)
``` ```
*Example:* **Example:**
A pre-defined script which rotates first one way, then the other, and prints logged angle: A pre-defined script which rotates first one way, then the other, and prints logged angle:
``` ```
from omnibot_client.Dummybot import run_dummybot from omnibot_client.Dummybot import run_dummybot
......
...@@ -3,7 +3,7 @@ requires = ["hatchling"] ...@@ -3,7 +3,7 @@ requires = ["hatchling"]
build-backend = "hatchling.build" build-backend = "hatchling.build"
[project] [project]
name = "omnibot_client" name = "omnibot"
version = "0.0.1" version = "0.0.1"
authors = [ authors = [
{ name="Felix Agner", email="felix.agner@control.lth.se" }, { name="Felix Agner", email="felix.agner@control.lth.se" },
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment