diff --git a/README.md b/README.md index 974ef4e4b..32d74e9ce 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. diff --git a/utils/Gruntfile.js b/utils/Gruntfile.js index 54c0edad5..2bac6b39e 100644 --- a/utils/Gruntfile.js +++ b/utils/Gruntfile.js @@ -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' } },