Readme updates
This commit is contained in:
Andrew Stewart
parent
cb2cd02eca
commit
db2283ee1f
64
README.md
64
README.md
|
|
@ -1,24 +1,37 @@
|
|||
# Cylon.js
|
||||
|
||||
Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and physical computing using node.js
|
||||
|
||||
It provides a simple, yet powerful way to create solutions that incorporate multiple, different hardware devices at the same time.
|
||||
|
||||
Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)
|
||||
# Cylon.js
|
||||
|
||||
[](http://travis-ci.org/hybridgroup/cylon)
|
||||
|
||||
Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics and
|
||||
physical computing using Node.js.
|
||||
|
||||
It provides a simple, yet powerful way to create solutions that incorporate
|
||||
multiple, different hardware devices at the same time.
|
||||
|
||||
Want to use Ruby on robots? Check out our sister project Artoo
|
||||
(http://artoo.io).
|
||||
|
||||
Want to use the Go programming language to power your robots? Check out our
|
||||
sister project Gobot (http://gobot.io).
|
||||
|
||||
## Getting Started
|
||||
|
||||
Install the module with: `npm install cylon`
|
||||
All you need to get started is the `cylon` module:
|
||||
|
||||
Then install modules for whatever hardware support you want to use from your robot. For example, `npm install cylon-firmata` to use Cylon with an Arduino using the Firmata protocol.
|
||||
npm install cylon
|
||||
|
||||
Then install modules for whatever hardware support you want to use from your
|
||||
robot (in this case, an Arduino using the Firmata protocol):
|
||||
|
||||
npm install cylon-firmata
|
||||
|
||||
## Examples
|
||||
|
||||
**Note:** before running examples in the `examples/` dir from source, make sure to compile using `grunt coffee` first.
|
||||
**Note:** before running examples in the `examples/` dir from source, make sure
|
||||
to compile using `grunt coffee` first.
|
||||
|
||||
### Javascript:
|
||||
|
||||
```javascript
|
||||
var Cylon = require("cylon");
|
||||
|
||||
|
|
@ -38,6 +51,7 @@ robot.start();
|
|||
```
|
||||
|
||||
### CoffeeScript:
|
||||
|
||||
```coffee-script
|
||||
Cylon = require "cylon"
|
||||
|
||||
|
|
@ -57,36 +71,45 @@ robot.start()
|
|||
```
|
||||
|
||||
## Hardware Support
|
||||
Cylon.js has a extensible system for connecting to hardware devices. The following robotics, physical computing, or software platforms are currently supported:
|
||||
|
||||
- [Ardrone](http://ardrone2.parrot.com/) <=> [Adaptor/Drivers](https://github.com/hybridgroup/cylon-ardrone)
|
||||
- [Arduino](http://www.arduino.cc/) <=> [Adaptor](https://github.com/hybridgroup/cylon-firmata)
|
||||
- [Leap Motion](https://www.leapmotion.com/) <=> [Adaptor/Driver](https://github.com/hybridgroup/cylon-leapmotion)
|
||||
- [Raspberry Pi](http://www.raspberrypi.org/) <=> [Adaptor](https://github.com/hybridgroup/cylon-raspi)
|
||||
- [Salesforce](http://www.force.com/) <=> [Adaptor/Driver](https://github.com/hybridgroup/cylon-force)
|
||||
- [Sphero](http://www.gosphero.com/) <=> [Adaptor/Driver](https://github.com/hybridgroup/cylon-sphero)
|
||||
Cylon.js has a extensible system for connecting to hardware devices. The
|
||||
following robotics, physical computing, or software platforms are currently
|
||||
supported:
|
||||
|
||||
Support for many devices that use General Purpose Input/Output (GPIO) have a shared set of drivers provded using the cylon-gpio module:
|
||||
- [Ardrone](http://ardrone2.parrot.com/) <==> [Adaptor/Drivers](https://github.com/hybridgroup/cylon-ardrone)
|
||||
- [Arduino](http://www.arduino.cc/) <==> [Adaptor](https://github.com/hybridgroup/cylon-firmata)
|
||||
- [Leap Motion](https://www.leapmotion.com/) <==> [Adaptor/Driver](https://github.com/hybridgroup/cylon-leapmotion)
|
||||
- [Raspberry Pi](http://www.raspberrypi.org/) <==> [Adaptor](https://github.com/hybridgroup/cylon-raspi)
|
||||
- [Salesforce](http://www.force.com/) <==> [Adaptor/Driver](https://github.com/hybridgroup/cylon-force)
|
||||
- [Sphero](http://www.gosphero.com/) <==> [Adaptor/Driver](https://github.com/hybridgroup/cylon-sphero)
|
||||
|
||||
Support for many devices that use General Purpose Input/Output (GPIO) have
|
||||
a shared set of drivers provded using the cylon-gpio module:
|
||||
|
||||
- [GPIO](https://en.wikipedia.org/wiki/General_Purpose_Input/Output) <=> [Drivers](https://github.com/hybridgroup/cylon-gpio)
|
||||
|
||||
Support for devices that use Inter-Integrated Circuit (I2C) have a shared set of drivers provded using the cylon-i2c module:
|
||||
Support for devices that use Inter-Integrated Circuit (I2C) have a shared set of
|
||||
drivers provded using the cylon-i2c module:
|
||||
|
||||
- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) <=> [Drivers](https://github.com/hybridgroup/cylon-i2c)
|
||||
|
||||
More platforms and drivers are coming soon...
|
||||
|
||||
## Documentation
|
||||
We're busy adding documentation to our web site at http://cylonjs.com/ please check there as we continue to work on Cylon.js
|
||||
|
||||
We're busy adding documentation to our web site at http://cylonjs.com/ please
|
||||
check there as we continue to work on Cylon.js
|
||||
|
||||
Thank you!
|
||||
|
||||
## Contributing
|
||||
|
||||
In lieu of a formal styleguide, take care to maintain the existing coding style.
|
||||
Add unit tests for any new or changed functionality. Lint and test your code
|
||||
using [Grunt](http://gruntjs.com/).
|
||||
|
||||
## Release History
|
||||
|
||||
Version 0.1.0 - Initial release for ongoing development
|
||||
|
||||
Version 0.2.0 - Cylon.Basestar to help develop external adaptors/drivers
|
||||
|
|
@ -96,4 +119,5 @@ Version 0.3.0 - Improved Cylon.Basestar, and added API
|
|||
Version 0.4.0 - Refactor proxy in Cylon.Basestar, improve API
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2013 The Hybrid Group. Licensed under the Apache 2.0 license.
|
||||
|
|
|
|||
Loading…
Reference in New Issue