generated from ijnek/ros2_template_repo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,30 +8,54 @@ This repository contains a tool for generating soccer field maps. It includes a | |
|
||
## Installation | ||
|
||
### Installation using ROS 2 | ||
|
||
To install the tool, run the following commands in your colcon workspace: | ||
|
||
```bash | ||
```shell | ||
git clone [email protected]:ros-sports/soccer_field_map_generator.git src/soccer_field_map_generator | ||
rosdep install --from-paths src --ignore-src -r -y | ||
colcon build | ||
``` | ||
|
||
Don't forget to source your workspace after building: | ||
|
||
```bash | ||
```shell | ||
source install/setup.bash | ||
``` | ||
|
||
### Installation using only Python | ||
|
||
First I would recommend creating a virtual environment: | ||
|
||
```shell | ||
python3 -m venv venv | ||
source venv/bin/activate | ||
``` | ||
|
||
Then install the tool using pip: | ||
|
||
```shell | ||
pip install "git+https://github.com/ros-sports/soccer_field_map_generator.git#egg=soccer_field_map_generator&subdirectory=soccer_field_map_generator" | ||
``` | ||
|
||
|
||
## Usage | ||
|
||
### GUI | ||
|
||
To launch the GUI, run the following command: | ||
|
||
```bash | ||
```shell | ||
ros2 run soccer_field_map_generator gui | ||
``` | ||
|
||
or this command if you installed the tool using pip: | ||
|
||
```shell | ||
python -m soccer_field_map_generator.gui | ||
``` | ||
|
||
You should see a window like this: | ||
|
||
![GUI](gui.png) | ||
|
@@ -40,6 +64,12 @@ You should see a window like this: | |
|
||
To generate a map using the command-line interface, run the following command: | ||
|
||
```bash | ||
```shell | ||
ros2 run soccer_field_map_generator cli [output_file] [config_file] [options] | ||
``` | ||
|
||
or this command if you installed the tool using pip: | ||
|
||
```shell | ||
python -m soccer_field_map_generator.cli [output_file] [config_file] [options] | ||
``` |