// readme

ROS/ROS2 Examples

This repository contains ROS/ROS2 examples for environment setup, tutorials, and people and vehicles.

Environment Setup

Run serve.bat (which runs mkdocs serve; any changes must also be verified by running this script to check the modified content on the web page). It will open a browser showing the homepage. For details, see serve.bat. For documentation writing conventions, see the homepage of the doc repository.

Notes

  • Before submitting a Pull Request, check the following:
    • You must use mkdocs serve --livereload to check that the web page shows the desired changes before submitting
    • The Pull Request title and commit messages must not be arbitrary; they need to explain why the change was made, not just what was changed
    • Check that the content under ‘File changed’ on the Pull Request page is the intended change
    • Check whether the Pull Request page shows red warnings (conflicts); if so, merge the repository’s latest changes before creating…