Skip to content

Commit

Permalink
Adds reference to tutorial in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenjameslee committed Mar 21, 2017
1 parent d9217ca commit 828034f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"prepublish": "npm run dist",
"preghpages": "npm run build && shx rm -rf gh-pages && shx mkdir gh-pages && shx cp -r examples/* gh-pages",
"ghpages": "npm run preghpages && ghpages -p gh-pages",
"start": "npm run dev",
"start": "node ./server/server.js",
"test": "karma start ./tests/unit/karma.conf.js",
"test:firefox": "karma start ./tests/unit/karma.conf.js --browsers Firefox",
"test:chrome": "karma start ./tests/unit/karma.conf.js --browsers Chrome",
Expand Down
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,16 @@ Features

Getting Started
---------------

Follow [this tutorial](https://github.com/haydenjameslee/networked-aframe/blob/master/docs/Tutorial:%20Create%20your%20first%20Networked-Aframe%20experience.md) to get started.

To get the examples running on your own PC run:

```sh
git clone https://github.com/haydenjameslee/networked-aframe.git # Clone the repository.
cd networked-aframe
npm install && npm run easyrtc-install # Install dependencies.
npm start # Start the local development server.
npm run dev # Start the local development server.
```
With the server running, browse the examples at `http://localhost:8080`. Open another browser tab and point it to the same URL to see the other client.

Expand Down Expand Up @@ -245,6 +250,7 @@ Stay in Touch
Help and More Information
------------------------------

* [Getting started tutorial](https://github.com/haydenjameslee/networked-aframe/blob/master/docs/Tutorial:%20Create%20your%20first%20Networked-Aframe%20experience.md)
* [Live demo site](http://haydenlee.io/networked-aframe)
* [A-Frame](https://aframe.io/)
* [WebVR](https://webvr.info/)
Expand Down

0 comments on commit 828034f

Please sign in to comment.