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

add new setup instructions to README

Browse source
This commit is contained in:
Todd Treece 2016-11-10 14:14:59 +00:00
parent 11555141eb
commit ea2435a340
2 changed files with 14 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -10,27 +10,23 @@ If you would like to connect to a headless Raspberry Pi for setting up WiFi acce
## 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][3] project.
Make sure you have the latest 4.x version of Node.js installed on your Raspberry Pi. You can install it
using the [NodeSource][3] installer.
```console
pi@xcarve ~ $ curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
pi@xcarve ~ $ sudo apt-get install -y nodejs
pi@xcarve ~ $ node -v
v0.12.6
v4.6.2
```
Make sure the global `node_modules` folder on your Raspberry Pi is writable by the `pi` user.
Install `xcarve-server` on your Raspberry Pi.
```console
pi@xcarve ~ $ sudo chown -R pi /usr/local
pi@xcarve ~ $ sudo npm install -g xcarve-server
```
Install `forever`, `forever-service`, and `xcarve-server` on your Raspberry Pi.
```console
pi@xcarve ~ $ npm install -g forever forever-service xcarve-server
```
## Starting the Service
## Starting the Server
If everything has been installed, you can start the service by running the following command:
@ -47,7 +43,7 @@ pi@xcarve ~ $ xcarve-server start
starting service on port 1338...
```
## Stopping the Service
## Stopping the Server
```console
pi@xcarve ~ $ xcarve-server stop
@ -57,15 +53,15 @@ 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][1].
[v0.2.7 of the Easel local OS X installer][1].
All other code is Copyright (c) 2015 Adafruit Industries. Licensed under the MIT license.
All other code is Copyright (c) 2015-2016 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][2]!
[1]: http://s3.amazonaws.com/easel-prod/paperclip/sender_version_mac_installers/10/original/Easel_Local_v0.2.1.pkg?1435076999
[1]: http://easel.inventables.com/downloads
[2]: https://adafruit.com
[3]: http://node-arm.herokuapp.com
[3]: https://github.com/nodesource/distributions
[4]: https://learn.adafruit.com/the-adafruit-raspberry-pi-finder

2
package.json
View file

@ -1,6 +1,6 @@
{
"name": "xcarve-server",
"version": "1.1.0",
"version": "1.0.11",
"bin": "./cli",
"license": "MIT",
"iris": {