OpenSimulationInterface / open-simulation-interface

A generic interface for the environmental perception of automated driving functions in virtual scenarios.
Other
269 stars 125 forks source link

Links in README and example moved to docu #720

Closed PhRosenberger closed 1 year ago

PhRosenberger commented 1 year ago

#### Reference to a related issue in the repository This PR should solve #719.

Add a description

As discussed in the last CCB meeting, we should change the README to only link to the usage examples in the official documentation.

Required steps:

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

If you can’t check all of them, please explain why. If all boxes are checked or commented and you have achieved at least one positive review, you can assign the label ReadyForCCBReview!

PhRosenberger commented 1 year ago

@philipwindecker I do not know, if Syntax highlighting will work for the python-script example.

PhRosenberger commented 1 year ago

@philipwindecker I changed the links to the official docu and the classes list to antora, as there was a todo. Please check that, as well.

philipwindecker commented 1 year ago

@philipwindecker I do not know, if Syntax highlighting will work for the python-script example.

Not as is. The source is set to ruby instead of python, therefore applying different styling rules. I will commit a change to that. With that, it will render correctly.

PhRosenberger commented 1 year ago

@philipwindecker I changed the links to the official docu and the classes list to antora, as there was a todo. Please check that, as well.

@philipwindecker is this ok for you, as well?

pmai commented 1 year ago

CCB on 2023-03-27: Merge as-is.