Skip to content

Commit 2dc939c

Browse files
committed
Add setup guide to docs
1 parent 988cfcc commit 2dc939c

1 file changed

Lines changed: 89 additions & 0 deletions

File tree

setup.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Setting up your NodeBots Environment
2+
3+
If you have all of this installed before you arrive then you'll be ready to get cracking and start playing with hardware.
4+
5+
If any of this isn't working, don't worry, our friendly team will be able to help you on the day but it's important to have everything downloaded or you'll be waiting a while to get it onto your machine.
6+
7+
After you have everything installed, and want to get the best out of a NodeBots event, then we highly recommend trying out the node school nodebot-workshop adventure, goto [node school](http://nodeschool.io/) for more information
8+
9+
### Mac OSX
10+
11+
* XCode - Install from the Mac Store. If you have installed the Command Line Tools through another means (eg Homebrew) then you won't need to do this. This is a big download, you don't want to be doing this on the day or you'll miss out on an hour of the fun.
12+
* Development command line tools - Easiest way to do this is from xcode itself: [See thread here at StackOverflow](http://stackoverflow.com/questions/9329243/xcode-4-4-command-line-tools)
13+
* Your choice of HomeBrew or MacPorts. We'd recommend [homebrew](http://brew.sh/) as it makes getting node up and running easy.
14+
* NodeJS - [Follow the appropriate directions here](http://nodejs.org)
15+
* Arduino - [Mac Install guide](http://arduino.cc/en/Guide/MacOSX)
16+
17+
Finally - attempt to install node-serialport as this will test everything is working:
18+
19+
```
20+
npm install serialport
21+
```
22+
23+
If you can install node-serialport then you're pretty much good to go.
24+
25+
The following commands will also install all these components using Homebrew and Cask.
26+
It assumes you are using OS X.9 or above. If you are using an earlier version of OS X
27+
then you will need to install XCode from the App Store and then install the command line tools;
28+
or download the command line development tools from the Apple developer site and install.
29+
30+
```
31+
#! /usr/bin/env bash
32+
33+
# Install Apple CLI Dev tools, java, node, Arduino IDE etc
34+
35+
xcode-select --install # Works on Mavericks and hopefully above
36+
37+
echo
38+
read -p "Please wait until CLI tools are installed and press enter" < /dev/tty
39+
40+
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
41+
42+
#Symlink Cask apps into the normal place. Add this to login scripts as well
43+
export HOMEBREW_CASK_OPTS="--appdir=/Applications"
44+
45+
brew tap caskroom/cask
46+
brew install brew-cask
47+
48+
brew cask install java
49+
50+
brew install minicom # Useful to connect to serial devices
51+
brew install node
52+
brew cask install arduino
53+
sudo npm -g install serialport
54+
```
55+
56+
### Linux
57+
58+
Linux is generally pretty straight forward. Install the following (assuming Ubuntu / Debian style machines):
59+
60+
* Arduino [Available here to install manually](http://playground.arduino.cc/Learning/Linux) or a simple 'apt-get install arduino' should do it for a relatively recent version.
61+
* NodeJS: [Source install instructions here](http://howtonode.org/how-to-install-nodejs). Don't install via your package manager as you really need an up-to-date version of node to work with hardware.
62+
63+
Finally - attempt to install node-serialport as this will test everything is working:
64+
65+
```
66+
npm install serialport
67+
```
68+
69+
### Windows
70+
71+
_Please note_
72+
73+
Windows users generally have the most problems with getting up and running of anyone. Please ensure you can install Johnny Five before coming to the event or you may lose time on the day hunting for issues.
74+
75+
76+
Install the following:
77+
78+
* Python 2.7.x [Download here](http://www.python.org/download/releases/2.7.5/) - Just download the bit version you need and install the exe.
79+
* NodeJS: [Windows Installer here](http://nodejs.org/download/)
80+
81+
82+
```
83+
npm install johnny-five
84+
```
85+
86+
This will shake out any problems you've got. It's pretty common to have troubles with Windows but they are fairly well documented and a quick google of the error message will usually resolve it.
87+
88+
---
89+
Documentation kindly copied from nodebotsau

0 commit comments

Comments
 (0)