search

personalrobotics / or_rviz

OpenRAVE viewer plugin that publishes the environment to RViz as InteractiveMarkers.
BSD 2-Clause "Simplified" License
5 stars 5 forks source link

Added a README #14

Closed mkoval closed 9 years ago

mkoval commented 9 years ago

I took a stab at fleshing out the README as part of our larger documentation effort.

@mklingen @psigen Anything else we should add here?

mkoval commented 9 years ago

@aaronjoh Can you take a look?

aaronjoh commented 9 years ago

The out-of-process viewer example needs a little more detail. Running this:

import openravepy
env = openravepy.Environment()
env.SetViewer('InteractiveMarker')

as suggested by the readme, and then separately running:

rosrun rviz rviz

does not work and puts out this error:

[ERROR] [1423682423.086219712]: PluginlibFactory: The plugin for class 'or_interactivemarker::rviz::EnvironmentDisplay' failed to load.  Error: Could not find library corresponding to plugin or_interactivemarker::rviz::EnvironmentDisplay. Make sure the plugin description XML file has the correct name of the library and that the library actually exists.

I'm sure this is just me missing a step, but I'm working only from the Readme.md. In-process viewer launches, though for both a suggested action or test that actually does something would be nice.

It would similarly be nice to have scripts/test.py either be the same as what is indicated in the readme, or have the readme setup how to run the test script.

mkoval commented 9 years ago

@aaronjoh I made some changes to address your comments. Can you take another look?

aaronjoh commented 9 years ago

Ok, looks good. Might add a note that the scripts/test.py is a good place to start (though that pulls the model from /opt/pr so i guess we might drop that from the release?)

mkoval commented 9 years ago

I updated the test.py script and now mention it in README.