Skip to content

Commit

Permalink
Add README files
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdavidfagan committed Oct 23, 2022
1 parent 27dc98d commit 5060475
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion moveit_py/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MoveIt Python Library (beta-release)
# MoveIt2 Python Library (beta-release)
<img src="./banner.png" width="50%">

`moveit_py` is a Python library for interfacing with the core functionalities of Moveit 2.
Expand Down
9 changes: 9 additions & 0 deletions moveit_py/moveit_py/servo_client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Servo Module
This module provides a client for interacting with MoveIt servo.

# Tutorial
Add links to official tutorials here.

# Supported Devices
* PS4 DualShock Controller
* Oculus Quest 2 (plans to support this device)
7 changes: 7 additions & 0 deletions moveit_py/src/moveit_py/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# MoveIt2 Pybind11 Bindings

This directory contains the [Pybind11](https://pybind11.readthedocs.io/en/stable/) binding code used by the moveit_py package.
The root of this directory contains the actual module definitions (e.g. `core.cpp` defines the `moveit_py.core` module).

The structure of subfolders in this directory reflects that of the MoveIt2 C++ codebase. Within each subfolder you will find the actual binding code that each module leverages.
For instance if I wished to understand how the `PlanningScene` object is being binded I would view the files in `./moveit_core/planning_scene/`.

0 comments on commit 5060475

Please sign in to comment.