Skip to content

Commit

Permalink
Tweaks to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sea-bass committed Oct 6, 2024
1 parent 387844a commit 665b7a0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ srdfdom

Parser for the Semantic Robot Description Format (SRDF).

Includes a cpp and a python parser, as well as a cpp writer.
Includes a C++ and a Python parser, as well as a C++ writer.

## GitHub Actions - Continuous Integration

Expand All @@ -26,14 +26,14 @@ Reused for srdf python parser

## C++ example

`test/test_parser.cpp` contains examples how to access the srdf elements from the cpp parser
`test/test_parser.cpp` contains examples of how to access the SRDF elements from the C++ parser.

## Python example

`test/test.py` contains examples how to access the srdf elements from the python parser
`test/test.py` contains examples on how to access the SRDF elements from the Python parser.

`scripts/display_srdf` reads a srdf from a file given in a command line argument and displays it in a yaml format.
If an output option (`-o <filename>`) is provided, it dumps the xml (re-generated from parsed input xml).
`scripts/display_srdf` reads SRDF from a file given in a command line argument and displays it in a YAML format.
If an output option (`-o <filename>`) is provided, it dumps the XML (re-generated from parsed input XML) to file.

example:

Expand Down

0 comments on commit 665b7a0

Please sign in to comment.