Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gtfl #25

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Gtfl #25

Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Customize README, package, and index.html for our project
  • Loading branch information
seandunlap authored May 19, 2018
commit 47ba9789c93d0063e0eb4a4dd62d86d80e72b203
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# A-Frame Boilerplate
# Peachtree Corners Veterans Monument

Boilerplate for creating WebVR scenes with [A-Frame](https://aframe.io).

Alternatively, check out the [A-Frame Starter on
glitch.com](https://glitch.com/~aframe) for a more interactive way on getting
started.
Welcome to the [Peachtree Corners Veterans Monument](http://www.ptcvets.net/) WebVR Scene, based on [A-Frame](https://aframe.io/).

## Getting Started

@@ -14,7 +10,7 @@ There are two easy options for obtaining this A-Frame scene. It's then up to you

[<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/Peachtree-Corners-Vetereans-Monument/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/
@@ -23,11 +19,11 @@ After you have __[downloaded and extracted this `.zip` file](https://github.com/

### <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/Peachtree-Corners-Vetereans-Monument/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/Peachtree-Corners-Vetereans-Monument/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
git clone https://github.com/Peachtree-Corners-Vetereans-Monument/aframe-boilerplate.git
cd aframe-boilerplate && rm -rf .git && npm install && npm start
open http://localhost:3000/

@@ -37,7 +33,7 @@ After you have __[forked this repo](https://github.com/aframevr/aframe-boilerpla

### <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](https://codepen.io/seandunlap/full/mLKexe/)__ to dive right in. Enjoy!


## Publishing your scene
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
@@ -2,8 +2,8 @@
<html>
<head>
<meta charset="utf-8">
<title>Hello, World! - A-Frame</title>
<meta name="description" content="Hello, World! - A-Frame">
<title>Peachtree Corners Veterans Monument - A-Frame</title>
<meta name="description" content="Peachtree Corners Veterans Monument!">
<script src="https://aframe.io/releases/0.5.0/aframe.min.js"></script>
</head>
<body>
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "aframe-hello-world-boilerplate",
"description": "Boilerplate with A-Frame's 'Hello, World!' of WebVR.",
"version": "0.3.0",
"name": "peachree-corners-veterans-monument",
"description": "Peachtree Corners Veterans Monument A-Frame Scene",
"version": "0.0.1",
"license": "MIT",
"scripts": {
"start": "budo --live --verbose --port 3000 --open",
@@ -15,7 +15,6 @@
"keywords": [
"aframe",
"aframe-example",
"aframe-boilerplate",
"aframe-scene",
"webvr",
"vr"