Skip to content
This repository was archived by the owner on Dec 6, 2018. It is now read-only.

Commit

Permalink
prep for staghing
Browse files Browse the repository at this point in the history
  • Loading branch information
borismus committed Oct 18, 2016
1 parent 316828a commit e07abc1
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 20 deletions.
43 changes: 24 additions & 19 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# Building
Want to contribute? Great! First, read this page (including the small print at the end).

This project uses browserify to manage dependencies and build. Watchify is
especially convenient to preserve the write-and-reload model of development.
This package lives in the npm index. There is also a bower version of it, but it
is deprecated.
### Before you contribute
Before we can use your code, you must sign the
[Google Individual Contributor License Agreement]
(https://cla.developers.google.com/about/google-individual)
(CLA), which you can do online. The CLA is necessary mainly because you own the
copyright to your changes, even after your contribution becomes part of our
codebase, so we need your permission to use and distribute your code. We also
need to be sure of various other things—for instance that you'll tell us if you
know that your code infringes on other people's patents. You don't have to sign
the CLA until after you've submitted your code for review and a member has
approved it, but you must do it before we can put your code into our codebase.
Before you start working on a larger contribution, you should get in touch with
us first through the issue tracker with your idea so that we can help out and
possibly guide you. Coordinating up front makes it much easier to avoid
frustration later on.

Relevant commands:
### Code reviews
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose.

npm build - builds the module.
npm build-analytics - builds the module with analytics support.
npm watch - auto-builds the module whenever any source changes.


# Updating the npm entry

Once changes are made, a new version can be published to the index using the
following commands:

npm version <NEW_VERSION>
npm publish
git push
### The small print
Contributions made by corporations are covered by a different agreement than
the one above, the
[Software Grant and Corporate Contributor License Agreement]
(https://cla.developers.google.com/about/google-corporate).
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
VR View
=======

Please read the documentation available at
VR View allows you to embed 360 degree VR media into websites on desktop and
mobile. For more information, please read the documentation available at
<http://developers.google.com/cardboard/vrview>.

# Building

This project uses browserify to manage dependencies and build. Watchify is
especially convenient to preserve the write-and-reload model of development.
This package lives in the npm index.

Relevant commands:

npm build - builds the module.
npm build-analytics - builds the module with analytics support.
npm watch - auto-builds the module whenever any source changes.


# Updating the npm entry

Once changes are made, a new version can be published to the index using the
following commands:

npm version <NEW_VERSION>
npm publish
git push

0 comments on commit e07abc1

Please sign in to comment.