Permalink
Browse files

Adding front page of docs site, contributing

  • Loading branch information...
1 parent eb6d2d4 commit 8c404f3251607049fdd711450ea1fd38c78c24dc @sarahgp committed Aug 25, 2015
View
@@ -0,0 +1,8 @@
+# Contributing
+
+## 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 `hi@sarahgp.com`.
+
+## Development
View
@@ -102,7 +102,7 @@ module.exports = function(grunt) {
'src/client/lib/*.js',
'src/p5bots-server/app.js',
'src/p5bots-server/lib/*.js',
- 'src/README.md'],
+ 'doc/README.md'],
options: {
destination: 'doc'
}
View
@@ -0,0 +1,45 @@
+# Welcome to p5bots!
+
+* [How Does This Work?](#how-does-this-work)
+* [p5.Serial](#p5-serial)
+* [p5.Board](#p5-board)
+* [Issues](#issues)
+* [Getting Started](#getting-started)
+* [Contributing](#contributing)
+
+
+## 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).
+
+## p5.Serial
+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.
+
+## p5.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]()
+
+## Issues
+[Report issues on Github.](https://github.com/sarahgp/p5bots/issues)
+
+## Contributing
+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).
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -43,11 +43,33 @@ <h1 class="page-title">Home</h1>
<section>
- <article><h1>Full API Documentation for p5bots</h1><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse convallis diam ante. Vestibulum varius posuere dapibus. Maecenas at luctus massa. Duis scelerisque volutpat ipsum suscipit interdum. Quisque accumsan accumsan metus, vel varius nunc tincidunt at. Nunc et fringilla erat. Duis convallis blandit nisl quis viverra. Quisque gravida hendrerit turpis pulvinar tempor. Proin efficitur eleifend dolor, vel sagittis dolor convallis quis. Nullam finibus consectetur risus ac vehicula. Integer ac dui suscipit, gravida sapien nec, posuere nisl. Cras congue vestibulum dolor, eu elementum mi tempus vitae. Etiam eget lacus porttitor dui tincidunt finibus. Praesent ac purus justo. Phasellus est lorem, tincidunt eget faucibus cursus, ornare vitae dui.</p>
-<p>Proin blandit, urna ac congue porta, est justo eleifend nisl, in semper magna arcu vel nibh. Curabitur ac aliquet lorem. Phasellus volutpat lorem ut leo aliquet, et suscipit neque pretium. Curabitur interdum porta odio eu feugiat. Nulla facilisi. Morbi egestas neque in dui egestas, vel ultrices sem lobortis. Aenean urna ante, porttitor a vehicula ut, mattis in urna. Pellentesque malesuada at nulla non molestie. Phasellus nec leo a ex laoreet tempus quis eget leo. In vitae purus et ex dignissim sodales. Pellentesque tincidunt orci eget libero aliquet laoreet. Mauris lectus enim, scelerisque viverra justo eu, hendrerit egestas purus. Donec lacinia sem non volutpat facilisis. Sed vel diam ultricies ligula mollis placerat eget quis quam. Ut et sodales tortor, non vestibulum nunc.</p>
-<p>Cras interdum ipsum nec purus mollis pretium. Maecenas ornare, lectus id porta feugiat, elit ligula consequat urna, a eleifend lectus nisl finibus diam. In et sem vitae libero aliquam ullamcorper sit amet a ante. Nulla facilisi. Etiam sit amet volutpat arcu. Etiam dui ligula, pretium vel mi ac, lobortis ultricies nunc. Donec id risus vestibulum, elementum ex eget, vulputate orci. Cras id eros tincidunt, semper arcu et, consectetur odio. Sed posuere mi sit amet hendrerit rhoncus. Nunc fermentum est ut metus condimentum efficitur.</p>
-<p>Mauris ac eros augue. Morbi nec erat vel elit finibus mollis sed id turpis. Praesent tempus venenatis dolor, sit amet mattis neque sagittis auctor. Maecenas sit amet tortor id nibh aliquam pharetra. Donec nec nisl non turpis blandit luctus. In vitae felis enim. Aenean venenatis ex id fermentum faucibus. Etiam commodo turpis et aliquam luctus. Mauris turpis dui, varius eu tempor sed, varius blandit tellus. Cras elementum, lectus quis gravida malesuada, lorem erat malesuada lorem, vel gravida risus ex vitae purus. Fusce sollicitudin ut lorem sed rutrum. Etiam vitae imperdiet lectus. Quisque euismod vitae felis sed varius. Morbi consectetur hendrerit enim ac eleifend. Curabitur semper turpis ut nisl congue, a euismod leo pretium. In a nulla blandit, tincidunt risus quis, suscipit lectus.</p>
-<p>Donec maximus, lorem ac ullamcorper consectetur, metus ipsum scelerisque magna, at dignissim dolor eros at erat. Maecenas in enim sapien. Pellentesque cursus, odio tempor malesuada pulvinar, dui ipsum eleifend orci, sed aliquam eros tortor et elit. Quisque ut erat ac lectus sagittis laoreet. Donec vitae dolor nulla. Aliquam nec vehicula nunc. Nulla at dapibus augue. Phasellus iaculis vitae sapien ut fringilla. Donec sit amet facilisis purus, id vehicula felis.</p></article>
+ <article><h1>Welcome to p5bots!</h1><ul>
+<li><a href="#how-does-this-work">How Does This Work?</a></li>
+<li><a href="#p5-serial">p5.Serial</a></li>
+<li><a href="#p5-board">p5.Board</a></li>
+<li><a href="#issues">Issues</a></li>
+<li><a href="#getting-started">Getting Started</a></li>
+<li><a href="#contributing">Contributing</a></li>
+</ul>
+<h2>How Does This Work?</h2><p>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 <code>socket.io</code> library and <code>node.js</code> to send messages between the two devices, in a language each device can understand.</p>
+<p>This way, you can click on a sketch to light an LED or use temperature data to drive a sketch — or more.</p>
+<p><img src="img/how-it-works.png" alt="diagram of client, server, and microcontroller"></p>
+<p>p5bots comprises two sets of files: the client file, called <code>p5bots.js</code>, which is included in the <code>index.html</code> along with <code>p5.js</code> and your sketch; and the server files, called p5-server, which can be downloaded from <a href="https://www.npmjs.com/package/p5bots-server">npm</a>.</p>
+<p>If all this sounds crazy, you can also use p5bots from the <a href="https://github.com/processing/p5.js-editor">p5.js IDE</a>.</p>
+<h2>p5.Serial</h2><p>p5bots has a <a href="doc/module-Serial.html">serial method</a> that can be used in combination with an Arduino sketch listening for serial, much in the same way the Processing serial library can.</p>
+<p>For more details on this module, see <a href="doc/module-Serial.html">the p5.Serial reference page</a>.</p>
+<p>If you use serial only, you do not need to install Firmata on your board.</p>
+<h2>p5.Board</h2><p>The majority of p5bots functionality lives within p5.Board. Inspired by <a href="http://johnny-five.io/">Johnny-Five</a>, p5.Board provides a number of hardware-specific methods in addition to plain digital, analog, and pwm read/write methods.</p>
+<p>Details for these methods, plus examples can be found in the module pages. Example sketches and hardware diagrams are also available in <a href="https://github.com/sarahgp/p5bots/tree/master/examples">the examples directory on the p5bots Github</a>.</p>
+<h2>Getting Started</h2><p>Ready to go? Good entry points include:</p>
+<ul>
+<li><a href="">the Hello, World tutorial</a></li>
+<li><a href="">checking out examples on the method pages, say RGB LED</a></li>
+<li>reading about <a href="https://github.com/sarahgp/p5bots">the client API</a> and <a href="https://github.com/sarahgp/p5bots/tree/master/src/p5bots-server">p5-server</a> on Github</li>
+<li>or, <a href="">heading over to p5.js to learn more about the drawing library</a></li>
+</ul>
+<h2>Issues</h2><p><a href="https://github.com/sarahgp/p5bots/issues">Report issues on Github.</a></p>
+<h2>Contributing</h2><p>Want to fix an issue you've identified? Looking to create some functionality we have yet to add? Check out the <a href="https://github.com/sarahgp/p5bots">p5bots repo on Github</a> and, particularly, <a href="https://github.com/sarahgp/p5bots/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p></article>
</section>
@@ -64,7 +86,7 @@ <h1 class="page-title">Home</h1>
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Aug 18 2015 22:00:02 GMT-0400 (EDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 24 2015 21:06:12 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
View
@@ -112,7 +112,7 @@ <h1 class="page-title">Source: led.js</h1>
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Aug 18 2015 22:00:02 GMT-0400 (EDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 24 2015 21:06:12 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
@@ -386,7 +386,7 @@ <h4 class="name" id=".fade"><span class="type-signature">(static) </span>fade<sp
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Aug 18 2015 22:00:02 GMT-0400 (EDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 24 2015 21:06:12 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -1,4 +1,4 @@
-/*! p5bots.js v0.0.2 August 18, 2015 */
+/*! p5bots.js v0.0.2 August 24, 2015 */
(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.p5js = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(_dereq_,module,exports){
'use strict';
Oops, something went wrong.

0 comments on commit 8c404f3

Please sign in to comment.