Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update readme.rdoc and manifest comment

  • Loading branch information...
commit 3f17276b65b16c203084a31eb665ddd933e93cd0 1 parent 19e2c0b
Takashi Ogura authored
Showing with 25 additions and 8 deletions.
  1. +21 −0 rosruby/README.rdoc
  2. +2 −2 rosruby/Rakefile
  3. +2 −6 rosruby/manifest.xml
21 rosruby/README.rdoc
View
@@ -0,0 +1,21 @@
+= ROS Ruby Client: rosruby
+
+ROS is Robot Operating System developed by Willow Garage and open source communities. See http://ros.org/.
+
+rosruby is ROS client for ruby. You can program robots by ruby, very easily.
+
+== Requirements
+- ruby (1.8.x/1.9.x)
+- ROS (electric/fuerte)
+ - ROS requires python2.7 or more libraries
+
+== License
+BSD License
+
+== Documents
+
+=== project page
+- http://github.com/OTL/rosruby
+
+=== ROS wiki
+- http://ros.org/wiki/rosruby
4 rosruby/Rakefile
View
@@ -12,8 +12,8 @@ CLEAN << message_dir
require 'rake/rdoctask'
Rake::RDocTask.new do |rdoc|
rdoc.rdoc_dir = 'doc'
- rdoc.rdoc_files = FileList["lib/**/*.rb"]
- rdoc.main = "ROS::Node"
+ rdoc.rdoc_files = FileList["lib/**/*.rb", 'README.rdoc']
+ rdoc.main = 'README.rdoc'
rdoc.title = 'rosruby API'
end
8 rosruby/manifest.xml
View
@@ -1,8 +1,6 @@
<package>
- <description brief="rosruby">
-
- This is ruby learning project.
-
+ <description brief="A Ruby client library for ROS">
+ This package is a Ruby client library for ROS, the Robot Operating System.
</description>
<author>Takashi Ogura</author>
<license>BSD</license>
@@ -19,5 +17,3 @@
<rosdep name="rake"/>
</package>
-
-
Please sign in to comment.
Something went wrong with that request. Please try again.