ROS on Windows Documentation Repository

Visit https://aka.ms/ros/docs to read the generated documentation.

Build Locally

To test this generated HTML pages locally on your machine, you need a Python environment and run MkDocs tool.

:: git clone this repository.
:: change directory to the repository root.
pip install mkdocs-material
mkdocs serve

Then, a local web server will be running by MkDocs and now you can open the link from your browser and test the pages.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.