Skip to content

Commit

Permalink
docs: update README.md to reflect JSON file usage and add warnings fo…
Browse files Browse the repository at this point in the history
…r SVG map parser
  • Loading branch information
ll7 committed Dec 6, 2024
1 parent 550e201 commit e067103
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion map_editor/README.md
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).

0 comments on commit e067103

Please sign in to comment.