https://ms-iot.github.io/ROSOnWindows/

ROS on Windows Documentation Repository
https://ms-iot.github.io/ROSOnWindows/

ros ros2

Last synced: 3 months ago
JSON representation

ROS on Windows Documentation Repository

• Host: GitHub
• URL: https://ms-iot.github.io/ROSOnWindows/
• Owner: ms-iot
• License: mit
• Created: 2018-10-09T21:39:27.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-10T22:07:38.000Z (over 1 year ago)
• Last Synced: 2024-05-08T19:31:24.386Z (6 months ago)
• Topics: ros, ros2
• Language: Dockerfile
• Homepage: https://aka.ms/ros/docs
• Size: 12.3 MB
• Stars: 210
• Watchers: 35
• Forks: 48
• Open Issues: 127
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-robotic-tooling - ROSOnWindows - An experimental release of ROS1 for Windows. (Development Environment / Code and Run)
• LiDAR-Guide - ROS on Windows 10
• Autonomous-Systems-Guide - ROS on Windows 10
• Computer-Vision-Guide - ROS on Windows 10
• Deep-Learning-Guide - ROS on Windows 10
• MATLAB-Guide - ROS on Windows 10

README

        
# 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.

```bat

:: 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](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or

contact [[email protected]](mailto:[email protected]) with any additional questions or comments.