Skip to content

Commit

Permalink
Merge pull request RobotWebTools#28 from rctoris/devel
Browse files Browse the repository at this point in the history
readme updated
  • Loading branch information
baalexander committed Apr 10, 2013
2 parents 930c7c8 + 9edb737 commit acb51f0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 18 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
ros3djs [![Build Status](https://api.travis-ci.org/RobotWebTools/ros3djs.png)](https://travis-ci.org/RobotWebTools/ros3djs)
=======

#### 3D Visualization Library for use with the ROS JavaScript Libraries ####

#### 3D Visualization Library for use with the ROS JavaScript Libraries
For full documentation, see [the ROS wiki](http://ros.org/wiki/ros3djs) or check out some [working demos](http://robotwebtools.org/).

[JSDoc](http://robotwebtools.org/jsdoc/ros3djs/current/) can be found on the Robot Web Tools website.

This project is released as part of the [Robot Web Tools](http://robotwebtools.org/) effort.

### Usage ###
### Usage
Pre-built files can be found in either [ros3d.js](build/ros3d.js) or [ros3d.min.js](build/ros3d.min.js).

Alternatively, you can use the current release via the Robot Web Tools CDN ([full](http://cdn.robotwebtools.org/ros3djs/current/ros3d.js)) | ([min](http://cdn.robotwebtools.org/ros3djs/current/ros3d.min.js))

### Dependencies ###
### Dependencies
ros3djs depends on:

[EventEmitter2](https://github.com/hij1nx/EventEmitter2). The current supported version is 0.4.11.
Expand All @@ -29,21 +28,12 @@ The current supported version can be found [in this project](include/ColladaAnim
[roslibjs](https://github.com/RobotWebTools/roslibjs). The current supported version is r5.
The current supported version can be found [in this project](include/roslibjs/roslib.js) or on the Robot Web Tools CDN ([full](http://cdn.robotwebtools.org/roslibjs/r4/roslib.js)) | ([min](http://cdn.robotwebtools.org/roslibjs/r5/roslib.min.js)).

### Build ###
To build from source, use the provided [ANT script](utils/build.xml).

The script requires ANT, YUI Compressor, and JSDoc. To install these on an Ubuntu machine, use the following:

sudo apt-get install ant yui-compressor jsdoc-toolkit

To run the build script, use the following:

cd utils/
ant
### Build
Checkout [utils/README.md](utils/README.md) for details on building.

### License ###
### License
ros3djs is released with a BSD license. For full terms and conditions, see the [LICENSE](LICENSE) file.

### Authors ###
### Authors
See the [AUTHORS.md](AUTHORS) file for a full list of contributors.

2 changes: 1 addition & 1 deletion utils/Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = function(grunt) {
pkg: grunt.file.readJSON('package.json'),
concat: {
build: {
src : ['../src/Rod3D.js', '../src/**/*.js'],
src : ['../src/Ros3D.js', '../src/**/*.js'],
dest : '../build/ros3d.js'
}
},
Expand Down

0 comments on commit acb51f0

Please sign in to comment.