Skip to content

Commit

Permalink
Revert "format readme"
Browse files Browse the repository at this point in the history
This reverts commit 0e81cc2.
  • Loading branch information
ngokevin committed Aug 5, 2016
1 parent 0e81cc2 commit a0da65f
Showing 1 changed file with 13 additions and 35 deletions.
48 changes: 13 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,71 +6,49 @@ Boilerplate for creating WebVR scenes using A-Frame.

There are two easy options for obtaining this A-Frame scene. It's then up to you to make it your own!

### Option 1: Download the ZIP kit 📦
### <sup>Option 1:</sup> Download the ZIP kit 📦

[<img src="http://i.imgur.com/UVPZoM0.png" width="200">](https://github.com/aframevr/aframe-boilerplate/archive/master.zip)

After you have **[downloaded and extracted this `.zip`
file](https://github.com/aframevr/aframe-boilerplate/archive/master.zip)**
containing the contents of this repo, open the resulting directory, and you'll
be have your scene ready in these few steps:
After you have __[downloaded and extracted this `.zip` file](https://github.com/aframevr/aframe-boilerplate/archive/master.zip)__ containing the contents of this repo, open the resulting directory, and you'll be have your scene ready in these few steps:

npm install && npm start
open http://localhost:3000/

<hr>

### Option 2: Fork this GitHub repository 🍴🐙
### <small><sup>Option 2:</sup> Fork this Git repo 🍴🐙

Alternatively, you can **[fork this
repo](https://github.com/aframevr/aframe-boilerplate/fork)** to get started, if
you'd like to maintain a Git workflow.
Alternatively, you can __[fork this repo](https://github.com/aframevr/aframe-boilerplate/fork)__ to get started, if you'd like to maintain a Git workflow.

After you have **[forked this
repo](https://github.com/aframevr/aframe-boilerplate/fork)**, clone a copy of
your fork locally and you'll be have your scene ready in these few steps:
After you have __[forked this repo](https://github.com/aframevr/aframe-boilerplate/fork)__, clone a copy of your fork locally and you'll be have your scene ready in these few steps:

git clone https://github.com/aframevr/aframe-boilerplate.git
cd aframe-boilerplate && rm -rf .git && npm install && npm start
open http://localhost:3000/

> :iphone: **Mobile pro tip:** Upon starting the development server, the URL
> will be logged to the console. Load that URL from a browser on your mobile
> device. (If your mobile phone and computer are not on the same LAN, consider
> using [ngrok](https://ngrok.com/) for local development and testing.
> [Browsersync](https://www.browsersync.io/) is also worth a gander.)
> :iphone: **Mobile pro tip:** Upon starting the development server, the URL will be logged to the console. Load that URL from a browser on your mobile device. (If your mobile phone and computer are not on the same LAN, consider using [ngrok](https://ngrok.com/) for local development and testing. [Browsersync](https://www.browsersync.io/) is also worth a gander.)
<hr>

### Option 3: Fork this CodePen example 🍴💾✒️
### <small><sup>Option 3:</sup> Fork this CodePen example 🍴💾✒️

Or, you can simply __[fork this CodePen example](http://codepen.io/team/mozvr/pen/BjygdO?editors=100)__ to dive right in. Enjoy!

Or, you can simply **[fork this CodePen
example](http://codepen.io/team/mozvr/pen/BjygdO?editors=100)** to dive right
in. Enjoy!

## Publishing your scene

If you don't already know, GitHub offers free and awesome publishing of static
sites through **[https://pages.github.com/](GitHub Pages)**.
If you don't already know, GitHub offers free and awesome publishing of static sites through __[https://pages.github.com/](GitHub Pages)__.

To publish your scene to your personal GitHub Pages:

npm run deploy

And, it'll now be live at **http://`your_username`.github.io/** :)
And, it'll now be live at __http://`your_username`.github.io/__ :)

<hr>

To know which GitHub repo to deploy to, the `deploy` script first looks at the
optional [`repository`
key](https://docs.npmjs.com/files/package.json#repository) in the
[`package.json` file](package.json) (see [npm
docs](https://docs.npmjs.com/files/package.json#repository) for sample usage).
If the `repository` key is missing, the script falls back to using the local
git repo's remote origin URL (you can run the local command `git remote -v` to
see all your remotes; also, you may refer to the [GitHub
docs](https://help.github.com/articles/about-remote-repositories/) for more
information).
To know which GitHub repo to deploy to, the `deploy` script first looks at the optional [`repository` key](https://docs.npmjs.com/files/package.json#repository) in the [`package.json` file](package.json) (see [npm docs](https://docs.npmjs.com/files/package.json#repository) for sample usage). If the `repository` key is missing, the script falls back to using the local git repo's remote origin URL (you can run the local command `git remote -v` to see all your remotes; also, you may refer to the [GitHub docs](https://help.github.com/articles/about-remote-repositories/) for more information).

<hr>

Expand All @@ -97,7 +75,7 @@ To serve the site from a simple Node development server:

Then launch the site from your favourite browser:

[**http://localhost:3000/**](http://localhost:3000/)
[__http://localhost:3000/__](http://localhost:3000/)

If you wish to serve the site from a different port:

Expand Down

0 comments on commit a0da65f

Please sign in to comment.