Skip to content

Commit

Permalink
readmes updated and roslib updated to r5
Browse files Browse the repository at this point in the history
  • Loading branch information
rctoris committed Apr 10, 2013
1 parent eb8ff0d commit e1cddaf
Show file tree
Hide file tree
Showing 6 changed files with 156 additions and 138 deletions.
8 changes: 0 additions & 8 deletions AUTHORS

This file was deleted.

11 changes: 11 additions & 0 deletions AUTHORS.md
@@ -0,0 +1,11 @@
Original Authors
----------------

* [Russell Toris](http://users.wpi.edu/~rctoris/) (rctoris@wpi.edu)

Contributors
------------

* Jihoon Lee (jihoonlee.in@gmail.com)
* Brandon Alexander (balexander@willowgarage.com)

2 changes: 0 additions & 2 deletions CHANGELOG

This file was deleted.

2 changes: 2 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,2 @@
2013-04-10 - **r1**
* Initial development of ROS3D [(rctoris)](https://github.com/rctoris/)
26 changes: 8 additions & 18 deletions README.md
@@ -1,18 +1,17 @@
ros2djs
========
ros2djs [![Build Status](https://api.travis-ci.org/RobotWebTools/ros2djs.png)](https://travis-ci.org/RobotWebTools/ros2djs)
=======

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

For full documentation, see [the ROS wiki](http://ros.org/wiki/ros2djs) or check out some [working demos](http://robotwebtools.org/).

[JSDoc](http://robotwebtools.org/jsdoc/ros2djs/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 ###
Pre-built files can be found in either [ros3d.js](build/ros3d.js) or [ros3d.min.js](build/ros3d.min.js).
Pre-built files can be found in either [ros2d.js](build/ros2d.js) or [ros2d.min.js](build/ros2d.min.js).

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

### Dependencies ###
ros2djs depends on:
Expand All @@ -23,20 +22,11 @@ The current supported version can be found [in this project](include/EventEmitte
[EaselJS](https://github.com/CreateJS/EaselJS/). The current supported version is 0.6.0.
The current supported version can be found [in this project](include/EaselJS/easeljs.js) or on the Robot Web Tools CDN ([full](http://cdn.robotwebtools.org/EaselJS/0.6.0/easeljs.js)) | ([min](http://cdn.robotwebtools.org/EaselJS/0.6.0/easeljs.min.js)).

[roslibjs](https://github.com/RobotWebTools/roslibjs). The current supported version is r4.
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/r4/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:
[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)).

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

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

0 comments on commit e1cddaf

Please sign in to comment.