Please sign in to comment.
Adding front page of docs site, contributing
- Loading branch information...
Showing with 86 additions and 22 deletions.
|@@ -0,0 +1,8 @@|
|+## Be Nice|
|+As contributors to a p5.js library, p5bots collaborators are expected to abide by the [p5 Code of Conduct](https://github.com/processing/p5.js/blob/master/CONTRIBUTING.md).|
|+If you feel someone has violated this code or is otherwise making the community an unhappy place to be, please email Sarah at `email@example.com`.|
|@@ -0,0 +1,45 @@|
|+# Welcome to p5bots!|
|+* [How Does This Work?](#how-does-this-work)|
|+* [Getting Started](#getting-started)|
|+## How Does This Work?|
|+p5bots is a library that works to send messages from your browser, where you are running p5.js, to your microcontroller, most likely an Arduino. To do this, it uses the `socket.io` library and `node.js` to send messages between the two devices, in a language each device can understand.|
|+This way, you can click on a sketch to light an LED or use temperature data to drive a sketch — or more.|
|+![diagram of client, server, and microcontroller](img/how-it-works.png)|
|+p5bots comprises two sets of files: the client file, called `p5bots.js`, which is included in the `index.html` along with `p5.js` and your sketch; and the server files, called p5-server, which can be downloaded from [npm](https://www.npmjs.com/package/p5bots-server).|
|+If all this sounds crazy, you can also use p5bots from the [p5.js IDE](https://github.com/processing/p5.js-editor).|
|+p5bots has a [serial method](doc/module-Serial.html) that can be used in combination with an Arduino sketch listening for serial, much in the same way the Processing serial library can.|
|+For more details on this module, see [the p5.Serial reference page](doc/module-Serial.html).|
|+If you use serial only, you do not need to install Firmata on your board.|
|+The majority of p5bots functionality lives within p5.Board. Inspired by [Johnny-Five](http://johnny-five.io/), p5.Board provides a number of hardware-specific methods in addition to plain digital, analog, and pwm read/write methods.|
|+Details for these methods, plus examples can be found in the module pages. Example sketches and hardware diagrams are also available in [the examples directory on the p5bots Github](https://github.com/sarahgp/p5bots/tree/master/examples).|
|+## Getting Started|
|+Ready to go? Good entry points include:|
|+* [the Hello, World tutorial]()|
|+* [checking out examples on the method pages, say RGB LED]()|
|+* reading about [the client API](https://github.com/sarahgp/p5bots) and [p5-server](https://github.com/sarahgp/p5bots/tree/master/src/p5bots-server) on Github|
|+* or, [heading over to p5.js to learn more about the drawing library]()|
|+[Report issues on Github.](https://github.com/sarahgp/p5bots/issues)|
|+Want to fix an issue you've identified? Looking to create some functionality we have yet to add? Check out the [p5bots repo on Github](https://github.com/sarahgp/p5bots) and, particularly, [CONTRIBUTING.md](https://github.com/sarahgp/p5bots/blob/master/CONTRIBUTING.md).|
Oops, something went wrong.