Skip to content

Commit 659dc05

Browse files
ResseguieResseguie
committed
read me updates with website integration
incorporates and links to official johnny-five website
1 parent 3194221 commit 659dc05

File tree

3 files changed

+101
-65
lines changed

3 files changed

+101
-65
lines changed

‎README.md

+55-37
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,27 @@
4949
-->
5050
<img src="https://github.com/rwaldron/johnny-five/raw/master/assets/sgier-johnny-five.png">
5151

52-
# Node-isassemble Johnny-Five
52+
# Johnny-Five
53+
### The JavaScript Robotics Programming Framework
5354

5455
_Artwork by [Mike Sgier](http://msgierillustration.com)_
5556

5657
[![Build Status](https://travis-ci.org/rwaldron/johnny-five.svg?branch=master)](https://travis-ci.org/rwaldron/johnny-five) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/rwaldron/johnny-five?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5758

5859

59-
#### Johnny-Five is an Open Source, Firmata Protocol based, IoT and Robotics programming framework, developed at [Bocoup](http://bocoup.com). Johnny-Five programs can be written for Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Spark Core, TI Launchpad and more!
60+
61+
**Johnny-Five is an Open Source, Firmata Protocol based, IoT and Robotics programming framework, developed at [Bocoup](http://bocoup.com). Johnny-Five programs can be written for Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Spark Core, TI Launchpad and more!**
62+
63+
Johnny-Five has grown from a passion project into a tool for inspiring learning and creativity for people of all ages, backgrounds, and from all across the world.
64+
65+
Just interested in learning and building awesome things? You might want to start with the official [Johnny-Five website](http://johnny-five.io). The website combines content from this repo, the wiki, tutorials from the Bocoup blog and several third-party websites into a single, easily-discoverable source:
66+
67+
* If you want to find the API documentation, [that’s right here](http://johnny-five.io/api/).
68+
* Need to figure out what platform to use for a project? We put that stuff [here](http://johnny-five.io/platform-support/).
69+
* Need inspiration for your next NodeBot? Check out the [examples](http://johnny-five.io/examples/).
70+
* Want to stay up-to-date with projects in the community? [Check this out](http://johnny-five.io/articles/).
71+
* Need NodeBots community or Johnny-Five project updates and announcements? [This](http://johnny-five.io/news/) is what you’re looking for.
72+
6073

6174
Johnny-Five does not attempt to provide "all the things", but instead focuses on delivering robust, reality tested, highly composable APIs that behave consistently across all supported hardware platforms. Johnny-Five wants to be a baseline control kit for hardware projects, allowing you the freedom to build, grow and experiment with diverse JavaScript libraries of your own choice. Johnny-Five couples comfortably with:
6275

@@ -68,7 +81,28 @@ Johnny-Five does not attempt to provide "all the things", but instead focuses on
6881
...And that's only a few of the many explorable possibilities. Check out these exciting projects: [node-pulsesensor](https://www.npmjs.org/package/node-pulsesensor), [footballbot-workshop-ui](https://www.npmjs.org/package/footballbot-workshop-ui), [nodebotui](https://www.npmjs.org/package/nodebotui), [dublin-disco](https://www.npmjs.org/package/dublin-disco), [node-slot-car-bot](https://www.npmjs.org/package/node-slot-car-bot), [servo-calibrator](https://www.npmjs.org/package/servo-calibrator), [node-ardx](https://www.npmjs.org/package/node-ardx), [nodebot-workshop](https://www.npmjs.org/package/nodebot-workshop), [phone-home](https://www.npmjs.org/package/phone-home), [purple-unicorn](https://www.npmjs.org/package/purple-unicorn), [webduino](https://www.npmjs.org/package/webduino), [leapduino](https://www.npmjs.org/package/leapduino), [lasercat-workshop](https://www.npmjs.org/package/lasercat-workshop), [simplesense](https://www.npmjs.org/package/simplesense), [five-redbot](https://www.npmjs.org/package/five-redbot), [robotnik](https://www.npmjs.org/package/robotnik), [the-blender](https://www.npmjs.org/package/the-blender)
6982

7083

71-
#### Why JavaScript? [NodeBots: The Rise of JavaScript Robotics](http://www.voodootikigod.com/nodebots-the-rise-of-js-robotics)
84+
**Why JavaScript?**
85+
[NodeBots: The Rise of JavaScript Robotics](http://www.voodootikigod.com/nodebots-the-rise-of-js-robotics)
86+
87+
## Hello Johnny
88+
89+
The ubiquitous "Hello World" program of the microcontroller and SoC world is "blink an LED". The following code demonstrates how this is done using the Johnny-Five framework.
90+
91+
```javascript
92+
var five = require("johnny-five");
93+
var board = new five.Board();
94+
95+
board.on("ready", function() {
96+
// Create an Led on pin 13
97+
var led = new five.Led(13);
98+
// Blink every half second
99+
led.blink(500);
100+
});
101+
```
102+
103+
<img src="https://github.com/rwaldron/johnny-five/raw/master/assets/led-blink.gif">
104+
105+
> Note: Node will crash if you try to run johnny-five in the node REPL, but board instances will create their own contextual REPL. Put your script in a file.
72106
73107

74108
## Supported Hardware
@@ -79,7 +113,7 @@ For non-Arduino based projects, a number of platform-specific [IO Plugins](https
79113

80114
## Documentation
81115

82-
Documentation for the Johnny-Five API can be found [here](https://github.com/rwaldron/johnny-five/wiki) and [example programs here](https://github.com/rwaldron/johnny-five#example-programs).
116+
Documentation for the Johnny-Five API can be found [here](http://johnny-five.io/api/) and [example programs here](http://johnny-five.io/examples/).
83117

84118
## Guidance
85119

@@ -123,42 +157,12 @@ npm install johnny-five
123157
```
124158

125159

126-
## Johnny-Five is...
127-
128-
```javascript
129-
var five = require("johnny-five"),
130-
// or "./lib/johnny-five" when running from the source
131-
board = new five.Board();
132-
133-
board.on("ready", function() {
134-
135-
// Create an Led on pin 13 and strobe it on/off
136-
// Optionally set the speed; defaults to 100ms
137-
(new five.Led(13)).strobe();
138-
139-
});
140-
```
141-
[Watch it here!](http://jsfiddle.net/rwaldron/dtudh/show/light)
142-
143-
> Note: Node will crash if you try to run johnny-five in the node REPL, but board instances will create their own contextual REPL. Put your script in a file.
144-
145-
146-
147-
## Many fragments. Some large, some small.
160+
## Example Programs
148161

149-
#### [Wireless Nodebot](http://jsfiddle.net/rwaldron/88M6b/show/light) NEW!
150-
#### [Kinect Controlled Robot Arm](http://jsfiddle.net/rwaldron/XMsGQ/show/light/) NEW!
151-
#### [Biped Nodebot](http://jsfiddle.net/rwaldron/WZkn5/show/light/)
152-
#### [LCD Running Man](http://jsfiddle.net/rwaldron/xKwaU/show/light/)
153-
#### [Slider Controlled Panning Servo](http://jsfiddle.net/rwaldron/kZakv/show/light/)
154-
#### [Joystick Controlled Laser (pan/tilt) 1](http://jsfiddle.net/rwaldron/HPqms/show/light/)
155-
#### [Joystick Controlled Laser (pan/tilt) 2](http://jsfiddle.net/rwaldron/YHb7A/show/light/)
156-
#### [Joystick Controlled Claw](http://jsfiddle.net/rwaldron/6ZXFe/show/light/)
157-
#### [Robot Claw](http://jsfiddle.net/rwaldron/CFSZJ/show/light/)
158-
#### [Joystick, Motor & Led](http://jsfiddle.net/rwaldron/gADSz/show/light/)
162+
To get you up and running quickly, we provide a variety of examples for using each Johnny-Five component. One thing we’re especially excited about is the extensive collection of [Fritzing](http://fritzing.org/home/) diagrams you’ll find throughout the site. A huge part of doing any Johnny-Five project is handling the actual hardware, and we’ve included these as part of the documentation because we realised that instructions on how to write code to control a servo are insufficient without instructions on how to connect a servo!
159163

164+
To interactively navigate the examples, visit the [Johnny-Five examples](http://johnny-five.io/examples/) page on the official website. If you want to link directly to the examples in this repo, you can use one of the following links.
160165

161-
## Example Programs
162166
<!--extract-start:examples-->
163167

164168
### Board
@@ -353,6 +357,20 @@ board.on("ready", function() {
353357

354358
<!--extract-end:examples-->
355359

360+
## Many fragments. Some large, some small.
361+
362+
#### [Wireless Nodebot](http://jsfiddle.net/rwaldron/88M6b/show/light)
363+
#### [Kinect Controlled Robot Arm](http://jsfiddle.net/rwaldron/XMsGQ/show/light/)
364+
#### [Biped Nodebot](http://jsfiddle.net/rwaldron/WZkn5/show/light/)
365+
#### [LCD Running Man](http://jsfiddle.net/rwaldron/xKwaU/show/light/)
366+
#### [Slider Controlled Panning Servo](http://jsfiddle.net/rwaldron/kZakv/show/light/)
367+
#### [Joystick Controlled Laser (pan/tilt) 1](http://jsfiddle.net/rwaldron/HPqms/show/light/)
368+
#### [Joystick Controlled Laser (pan/tilt) 2](http://jsfiddle.net/rwaldron/YHb7A/show/light/)
369+
#### [Joystick Controlled Claw](http://jsfiddle.net/rwaldron/6ZXFe/show/light/)
370+
#### [Robot Claw](http://jsfiddle.net/rwaldron/CFSZJ/show/light/)
371+
#### [Joystick, Motor & Led](http://jsfiddle.net/rwaldron/gADSz/show/light/)
372+
373+
356374

357375
## Make: JavaScript Robotics
358376

‎assets/led-blink.gif

41.9 KB
Loading

‎tpl/.readme.md

+46-28
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
11
<img src="https://github.com/rwaldron/johnny-five/raw/master/assets/sgier-johnny-five.png">
22

3-
# Node-isassemble Johnny-Five
3+
# Johnny-Five
4+
### The JavaScript Robotics Programming Framework
45

56
_Artwork by [Mike Sgier](http://msgierillustration.com)_
67

78
[![Build Status](https://travis-ci.org/rwaldron/johnny-five.svg?branch=master)](https://travis-ci.org/rwaldron/johnny-five) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/rwaldron/johnny-five?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
89

910

10-
#### Johnny-Five is an Open Source, Firmata Protocol based, IoT and Robotics programming framework, developed at [Bocoup](http://bocoup.com). Johnny-Five programs can be written for Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Spark Core, TI Launchpad and more!
11+
12+
**Johnny-Five is an Open Source, Firmata Protocol based, IoT and Robotics programming framework, developed at [Bocoup](http://bocoup.com). Johnny-Five programs can be written for Arduino (all models), Electric Imp, Beagle Bone, Intel Galileo & Edison, Linino One, Pinoccio, pcDuino3, Raspberry Pi, Spark Core, TI Launchpad and more!**
13+
14+
Johnny-Five has grown from a passion project into a tool for inspiring learning and creativity for people of all ages, backgrounds, and from all across the world.
15+
16+
Just interested in learning and building awesome things? You might want to start with the official [Johnny-Five website](http://johnny-five.io). The website combines content from this repo, the wiki, tutorials from the Bocoup blog and several third-party websites into a single, easily-discoverable source:
17+
18+
* If you want to find the API documentation, [that’s right here](http://johnny-five.io/api/).
19+
* Need to figure out what platform to use for a project? We put that stuff [here](http://johnny-five.io/platform-support/).
20+
* Need inspiration for your next NodeBot? Check out the [examples](http://johnny-five.io/examples/).
21+
* Want to stay up-to-date with projects in the community? [Check this out](http://johnny-five.io/articles/).
22+
* Need NodeBots community or Johnny-Five project updates and announcements? [This](http://johnny-five.io/news/) is what you’re looking for.
23+
1124

1225
Johnny-Five does not attempt to provide "all the things", but instead focuses on delivering robust, reality tested, highly composable APIs that behave consistently across all supported hardware platforms. Johnny-Five wants to be a baseline control kit for hardware projects, allowing you the freedom to build, grow and experiment with diverse JavaScript libraries of your own choice. Johnny-Five couples comfortably with:
1326

@@ -19,7 +32,28 @@ Johnny-Five does not attempt to provide "all the things", but instead focuses on
1932
...And that's only a few of the many explorable possibilities. Check out these exciting projects: [node-pulsesensor](https://www.npmjs.org/package/node-pulsesensor), [footballbot-workshop-ui](https://www.npmjs.org/package/footballbot-workshop-ui), [nodebotui](https://www.npmjs.org/package/nodebotui), [dublin-disco](https://www.npmjs.org/package/dublin-disco), [node-slot-car-bot](https://www.npmjs.org/package/node-slot-car-bot), [servo-calibrator](https://www.npmjs.org/package/servo-calibrator), [node-ardx](https://www.npmjs.org/package/node-ardx), [nodebot-workshop](https://www.npmjs.org/package/nodebot-workshop), [phone-home](https://www.npmjs.org/package/phone-home), [purple-unicorn](https://www.npmjs.org/package/purple-unicorn), [webduino](https://www.npmjs.org/package/webduino), [leapduino](https://www.npmjs.org/package/leapduino), [lasercat-workshop](https://www.npmjs.org/package/lasercat-workshop), [simplesense](https://www.npmjs.org/package/simplesense), [five-redbot](https://www.npmjs.org/package/five-redbot), [robotnik](https://www.npmjs.org/package/robotnik), [the-blender](https://www.npmjs.org/package/the-blender)
2033

2134

22-
#### Why JavaScript? [NodeBots: The Rise of JavaScript Robotics](http://www.voodootikigod.com/nodebots-the-rise-of-js-robotics)
35+
**Why JavaScript?**
36+
[NodeBots: The Rise of JavaScript Robotics](http://www.voodootikigod.com/nodebots-the-rise-of-js-robotics)
37+
38+
## Hello Johnny
39+
40+
The ubiquitous "Hello World" program of the microcontroller and SoC world is "blink an LED". The following code demonstrates how this is done using the Johnny-Five framework.
41+
42+
```javascript
43+
var five = require("johnny-five");
44+
var board = new five.Board();
45+
46+
board.on("ready", function() {
47+
// Create an Led on pin 13
48+
var led = new five.Led(13);
49+
// Blink every half second
50+
led.blink(500);
51+
});
52+
```
53+
54+
<img src="https://github.com/rwaldron/johnny-five/raw/master/assets/led-blink.gif">
55+
56+
> Note: Node will crash if you try to run johnny-five in the node REPL, but board instances will create their own contextual REPL. Put your script in a file.
2357
2458

2559
## Supported Hardware
@@ -30,7 +64,7 @@ For non-Arduino based projects, a number of platform-specific [IO Plugins](https
3064

3165
## Documentation
3266

33-
Documentation for the Johnny-Five API can be found [here](https://github.com/rwaldron/johnny-five/wiki) and [example programs here](https://github.com/rwaldron/johnny-five#example-programs).
67+
Documentation for the Johnny-Five API can be found [here](http://johnny-five.io/api/) and [example programs here](http://johnny-five.io/examples/).
3468

3569
## Guidance
3670

@@ -74,31 +108,20 @@ npm install johnny-five
74108
```
75109

76110

77-
## Johnny-Five is...
78-
79-
```javascript
80-
var five = require("johnny-five"),
81-
// or "./lib/johnny-five" when running from the source
82-
board = new five.Board();
83-
84-
board.on("ready", function() {
85-
86-
// Create an Led on pin 13 and strobe it on/off
87-
// Optionally set the speed; defaults to 100ms
88-
(new five.Led(13)).strobe();
89-
90-
});
91-
```
92-
[Watch it here!](http://jsfiddle.net/rwaldron/dtudh/show/light)
111+
## Example Programs
93112

94-
> Note: Node will crash if you try to run johnny-five in the node REPL, but board instances will create their own contextual REPL. Put your script in a file.
113+
To get you up and running quickly, we provide a variety of examples for using each Johnny-Five component. One thing we’re especially excited about is the extensive collection of [Fritzing](http://fritzing.org/home/) diagrams you’ll find throughout the site. A huge part of doing any Johnny-Five project is handling the actual hardware, and we’ve included these as part of the documentation because we realised that instructions on how to write code to control a servo are insufficient without instructions on how to connect a servo!
95114

115+
To interactively navigate the examples, visit the [Johnny-Five examples](http://johnny-five.io/examples/) page on the official website. If you want to link directly to the examples in this repo, you can use one of the following links.
96116

117+
<!--extract-start:examples-->
118+
<%= eglinks %>
119+
<!--extract-end:examples-->
97120

98121
## Many fragments. Some large, some small.
99122

100-
#### [Wireless Nodebot](http://jsfiddle.net/rwaldron/88M6b/show/light) NEW!
101-
#### [Kinect Controlled Robot Arm](http://jsfiddle.net/rwaldron/XMsGQ/show/light/) NEW!
123+
#### [Wireless Nodebot](http://jsfiddle.net/rwaldron/88M6b/show/light)
124+
#### [Kinect Controlled Robot Arm](http://jsfiddle.net/rwaldron/XMsGQ/show/light/)
102125
#### [Biped Nodebot](http://jsfiddle.net/rwaldron/WZkn5/show/light/)
103126
#### [LCD Running Man](http://jsfiddle.net/rwaldron/xKwaU/show/light/)
104127
#### [Slider Controlled Panning Servo](http://jsfiddle.net/rwaldron/kZakv/show/light/)
@@ -109,11 +132,6 @@ board.on("ready", function() {
109132
#### [Joystick, Motor & Led](http://jsfiddle.net/rwaldron/gADSz/show/light/)
110133

111134

112-
## Example Programs
113-
<!--extract-start:examples-->
114-
<%= eglinks %>
115-
<!--extract-end:examples-->
116-
117135

118136
## Make: JavaScript Robotics
119137

0 commit comments

Comments
 (0)