-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README.md to reflect JSON file usage and add warnings fo…
…r SVG map parser
- Loading branch information
Showing
1 changed file
with
6 additions
and
1 deletion.
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 |
---|---|---|
@@ -1,11 +1,16 @@ | ||
# pygame based map editor from Marco | ||
|
||
This is a simple map editor from Marco who used pygame to create suitable .yaml files. | ||
This is a simple map editor from Marco who used pygame to create suitable .json files. | ||
|
||
Extensive documentation can be found in [docs/MAP_EDITOR_USAGE.md](../docs/MAP_EDITOR_USAGE.md) | ||
|
||
## SVG Map Parser | ||
|
||
> [!WARNING] | ||
> It is recommended to use the svg map parser from `robot_sf/nav/svg_map_parser.py` instead of this one. | ||
I prefer to use `robot_sf/nav/svg_map_parser.py`. | ||
|
||
Look at `examples/svg_map_example.py` for an example of how to use it. | ||
|
||
Further documentation can be found in [docs/SVG_MAP_PARSER.md](../docs/SVG_MAP_PARSER.md). |