From 5c51e803d75be86243391c667375500194266461 Mon Sep 17 00:00:00 2001 From: Felix Agner <felix.agner@control.lth.se> Date: Tue, 1 Nov 2022 13:38:44 +0100 Subject: [PATCH] small readme changes and changed the project name in the toml --- README.md | 6 +++--- pyproject.toml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ff9549a..3738525 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Description 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 On linux: @@ -18,7 +18,7 @@ To read positions from the crazyflie, use `z = bot.get_z()`, `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. ``` from omnibot.tcp import Connection @@ -46,7 +46,7 @@ with Connection(HOST) as bot: sleep(0.1) ``` -*Example:* +**Example:** A pre-defined script which rotates first one way, then the other, and prints logged angle: ``` from omnibot_client.Dummybot import run_dummybot diff --git a/pyproject.toml b/pyproject.toml index ccba303..8fc158d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "omnibot_client" +name = "omnibot" version = "0.0.1" authors = [ { name="Felix Agner", email="felix.agner@control.lth.se" }, -- GitLab