Revision: 7657 http://playerstage.svn.sourceforge.net/playerstage/?rev=7657&view=rev Author: robotos Date: 2009-05-14 07:34:37 +0000 (Thu, 14 May 2009)
Log Message: ----------- Move the information from the READMe to the .html file and delete the README Modified Paths: -------------- code/player/trunk/client_libs/libplayerc/bindings/ruby/libplayerc_rb.html Removed Paths: ------------- code/player/trunk/client_libs/libplayerc/bindings/ruby/README Deleted: code/player/trunk/client_libs/libplayerc/bindings/ruby/README =================================================================== --- code/player/trunk/client_libs/libplayerc/bindings/ruby/README 2009-05-14 04:32:05 UTC (rev 7656) +++ code/player/trunk/client_libs/libplayerc/bindings/ruby/README 2009-05-14 07:34:37 UTC (rev 7657) @@ -1,28 +0,0 @@ -These are the Ruby bindings for Player (part of the PlayerStage project). -http://playerstage.sourceforge.net/ - -THIS BINDINGS WILL NOT BE COMPILED BY DEFAULT! - -If you want to install this bindings edit the CMakeList file on -$PLAYER_SOURCES_ROOT/client_libs/libplayerc/bindings/CMakefile.txt - - -This is a work in progress, examples in examples/ -show what is hopefully working so far. - -The ruby examples connect to a local Player running in the default port. -Start Player before running any examples. -The examples will access underlying hardware so either you have Player running in the real robotic hardware -or read Player documentation to run Player with the Stage or Gazebo simulators. - -For instance, laser.rb can be run with Player and Gazebo as follows: - -gazebo worlds/pioneer2dx.cfg -player GAZEBO_ROOT/player-cfgs/gazebo.cfg -ruby test.rb laser - -Gazebo provides of an environment with an specific robot and laser (defined in pioneer2dx.cfg) -Player connects to gazebo and provides of robot and laser generic interfaces (defined in gazebo.cfg) -laser.rb controls a generic robot with a generic laser - - Modified: code/player/trunk/client_libs/libplayerc/bindings/ruby/libplayerc_rb.html =================================================================== --- code/player/trunk/client_libs/libplayerc/bindings/ruby/libplayerc_rb.html 2009-05-14 04:32:05 UTC (rev 7656) +++ code/player/trunk/client_libs/libplayerc/bindings/ruby/libplayerc_rb.html 2009-05-14 07:34:37 UTC (rev 7657) @@ -5,9 +5,37 @@ libplayerc_rb is a SWIG-generated Ruby interface to @ref player_clientlib_libplayerc. You can guess the Ruby API by a little mental translation of the symbol names in the C API. + + THIS BINDINGS WILL NOT BE COMPILED BY DEFAULT! (they are WIP) - For now, check out the @ref libplayerc_rb_example "example". + If you want to compile and install this bindings edit the CMakeList file on + $PLAYER_SOURCES_ROOT/client_libs/libplayerc/bindings/CMakeLists.txt + adding: + ADD_SUBDIRECTORY (ruby) + and configure/make/install player + If the bindings were installed correctly can be tested with: + ruby examples/test_bindings_installation.rb + + + Some examples in examples/ show what is hopefully working so far. + The ruby examples connect to a local Player running in the default port. + Start Player before running any examples. + The examples will access underlying hardware so either you have Player running in the real robotic hardware + or read Player documentation to run Player with the Stage or Gazebo simulators. + + For instance, laser.rb can be run with Player and Gazebo as follows: + + gazebo worlds/pioneer2dx.cfg + player GAZEBO_ROOT/player-cfgs/gazebo.cfg + ruby test.rb laser + + Gazebo provides of an environment with an specific robot and laser (defined in pioneer2dx.cfg) + Player connects to gazebo and provides of robot and laser generic interfaces (defined in gazebo.cfg) + laser.rb controls a generic robot with a generic laser + + + @todo Document this library properly. */ @@ -16,4 +44,5 @@ @brief An example of using libplayerc_rb @include playercrb_example.rb -*/ + + */ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. ------------------------------------------------------------------------------ The NEW KODAK i700 Series Scanners deliver under ANY circumstances! Your production scanning environment may not be a perfect world - but thanks to Kodak, there's a perfect scanner to get the job done! With the NEW KODAK i700 Series Scanner you'll get full speed at 300 dpi even with all image processing features enabled. http://p.sf.net/sfu/kodak-com _______________________________________________ Playerstage-commit mailing list Playerstage-commit@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/playerstage-commit