adafruit-mirror/xcarve-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

adds tutorial link to readme

Browse source
This commit is contained in:
Todd Treece 2015-08-18 07:04:56 -04:00
parent 0cf58cdab2
commit 7c99533367
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,31 +1,31 @@
# Raspberry Pi XCarve Server
A Node.js Raspberry Pi server for controlling a XCarve from a remote machine using [Easel](http://easel.inventables.com).
A Node.js Raspberry Pi server for controlling a XCarve from a remote machine using [Easel][5].
For detailed install instructions, please visit the tutorial on the [Adafruit Learning System][6].
## Connecting to a Headless Raspberry Pi
If you would like to connect to a headless Raspberry Pi for setting up WiFi access, you can use the
[Adafruit Raspberry Pi Finder](https://learn.adafruit.com/the-adafruit-raspberry-pi-finder) app to find and
connect to your Raspberry Pi.
[Adafruit Raspberry Pi Finder][4] app to find and connect to your Raspberry Pi.
## Installation
Make sure you have the latest stable version of Node.js installed on your Raspberry Pi. You can download
it from the [node-arm](http://node-arm.herokuapp.com/) project.
it from the [node-arm][3] project.
```
```console
pi@xcarve ~ $ node -v
v0.12.6
```
Make sure the global `node_modules` folder on your Raspberry Pi is writable by the `pi` user.
```
```console
pi@xcarve ~ $ sudo chown -R pi /usr/local
```
Install `forever-service` and `xcarve-server` on your Raspberry Pi.
```
```console
pi@xcarve ~ $ npm install -g forever-service xcarve-server
```
@ -33,7 +33,7 @@ pi@xcarve ~ $ npm install -g forever-service xcarve-server
If everything has been installed, you can start the service by running the following command:
```
```console
pi@xcarve ~ $ xcarve-server start
██╗ ██╗ ██████╗ █████╗ ██████╗ ██╗ ██╗███████╗
@ -47,7 +47,7 @@ starting service on port 1338...
```
## Stopping the Service
```
```console
pi@xcarve ~ $ xcarve-server stop
stopping service...
```
@ -55,10 +55,17 @@ stopping service...
## License
Some of the code included in the `lib/` folder of this repo was extracted from
[v0.2.1 of the Easel local OS X installer](http://s3.amazonaws.com/easel-prod/paperclip/sender_version_mac_installers/10/original/Easel_Local_v0.2.1.pkg?1435076999).
[v0.2.1 of the Easel local OS X installer][1].
All other code is Copyright (c) 2015 Adafruit Industries. Licensed under the MIT license.
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing products
from [Adafruit](https://adafruit.com)!
from [Adafruit][2]!
[1]: http://s3.amazonaws.com/easel-prod/paperclip/sender_version_mac_installers/10/original/Easel_Local_v0.2.1.pkg?1435076999
[2]: https://adafruit.com
[3]: http://node-arm.herokuapp.com
[4]: https://learn.adafruit.com/the-adafruit-raspberry-pi-finder
[5]: http://easel.inventables.com
[6]: https://learn.adafruit.com/control-an-xcarve-wirelessly