Addressing some of Brandon's feedback

immersive-web · Sep 11, 2019 · 8b6d4a9 · 8b6d4a9
1 parent 2f48d1c
commit 8b6d4a9
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,15 @@
 
 [![Build Status](https://travis-ci.com/immersive-web/webxr-input-profiles.svg?branch=master)](https://travis-ci.org/immersive-web/webxr-input-profiles)
 
-## Overview
-This repository contains the four separate packages.
+## Repository
+
+This repository contains information necessary for User Agents to have conformance in WebXR [`XRInputSource`] objects for all known hardware devices.  It also contains assets and a helper library for developers to visualize motion controllers reported though `XRInputSource` objects.  A preview page is also included to allow end-to-end validation of new hardware.  The master branch of this preview page is hosted on github here:
+
+**[Profile Validator and Viewer](https://immersive-web.github.io/webxr-input-profiles/packages/viewer/dist/index.html)**
+
+## Packages
 * The [registry](./packages/registry/README.md) package contains JSON files which define the intrinsic values for each type of `XRInputSource` hardware to ensure User Agent conformity.
-* The [assets](./packages/assets/README.md) package contains 3D assets and JSON files to describe the relationship between those assets and the associated `XRInputSource`.
+* The [assets](./packages/assets/README.md) package contains 3D assets and JSON files to describe the relationship between those assets and the associated `XRInputSource` profiles defined in the [registry](.  The build step of this package merges its content with the JSON files in the [registry](./packages/registry/README.md) package.
 * The [motion-controllers](./packages/motion-controllers/README.md) package contains a javascript library able to load the JSON descriptions published from the [assets](./packages/assets/README.md) package and create component-style representations of the `XRInputSource` data. This library is 3D engine agnostic.
 * The [viewer](./packages/viewer/README.md) package contains webpage page that uses the [motion-controllers](./packages/motion-controllers/README.md) library to load and view the profiles and assets from the [assets](./packages/assets/README.md) package.
 
-The [Profile Viewer](https://immersive-web.github.io/webxr-input-profiles/packages/viewer/dist/index.html) built out of the [viewer](./packages/viewer/README.md) package is also hosted by this repository.
-
-
diff --git a/packages/assets/README.md b/packages/assets/README.md
@@ -8,7 +8,7 @@ This package provides 3D assets and JSON descriptions of how to relate those ass
 ### Getting started
 To install this package:
 ```
-npm install webxr-input-profiles
+npm install @webxr-input-profiles/assets
 ```
 
 ### Licence
@@ -23,16 +23,13 @@ Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-
 ### Adding a profile
 The new profile JSON file must match an existing hardware profile in the [registry](../registry/README.md) repository and be conformant with the schema in this package's './schemas' folder.  It must also pass the verification steps performed as part of the package build. Once ready, submit a pull request using the [this](https://github.com/immersive-web/webxr-input-profiles/issues/52) template.
 
-### Building and testing
+### Development
 In general, this package should be built and tested from the root of the repository using the following command:
 > npm run test
 
-To build just this package invoke the following command from the root of the repository:
+To build just this package without running tests, invoke the following command from the root of the repository:
 > npm run build -- --scope @webxr-input-profiles/assets
 
-To test just this package invoke the following command from the root of the repository:
-> npm run testOnly -- assets
-
 ## Schema
 
 ### Profile id

diff --git a/packages/assets/profiles/samsung/samsung-gearvr.json b/packages/assets/profiles/samsung/samsung-gearvr.json
@@ -7,7 +7,7 @@
         }
     },
     "layouts": {
-        "none": {
+        "left-right-none": {
             "components" : {
                 "xr-standard-trigger" : {
                     "rootNodeName" : "SELECT",

diff --git a/packages/motion-controllers/README.md b/packages/motion-controllers/README.md
@@ -23,17 +23,17 @@ Per the [LICENSE.md](LICENCE.md) file, this package is made available under an M
 In general, this package should be built and tested from the root of the repository using the following command:
 > npm run test
 
-To build just this package invoke the following command from the root of the repository:
+To build just this package without running tests, invoke the following command from the root of the repository:
 > npm run build -- --scope @webxr-input-profiles/motion-controllers
 
-To test just this package invoke the following command from the root of the repository:
+To test just this package without building anything, invoke the following command from the root of the repository:
 > npm run testOnly -- motion-controllers
 
 ### Filing a bug
 Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-profiles/issues/52
 
 ### Filing a pull request
-Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-profiles/issues/52
+Fill in the steps for filing a pull request https://github.com/immersive-web/webxr-input-profiles/issues/52
 
 ### Profile Viewer
 Visual validation of this package combined with the [assets](../assets/README.md) package can be done using the [viewer](../viewer/README.md) package.

diff --git a/packages/registry/README.md b/packages/registry/README.md
@@ -43,9 +43,15 @@ The new profile JSON file must be conformant with the schema in the './schemas'
 In general, this package should be built and tested from the root of the repository using the following command:
 > npm run test
 
-To build just this package invoke the following command from the root of the repository:
+To build just this package without running tests, invoke the following command from the root of the repository:
 > npm run build -- --scope @webxr-input-profiles/registry
 
+### Filing a bug
+Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-profiles/issues/52
+
+### Filing a pull request
+Fill in the steps for filing a pull request https://github.com/immersive-web/webxr-input-profiles/issues/52
+
 ## Schema
 
 ![Diagram of top-level schema parts](./figures/Concepts.png)

diff --git a/packages/registry/profiles/microsoft/microsoft-045e-065d.json b/packages/registry/profiles/microsoft/microsoft-045e-065d.json
@@ -1,6 +1,6 @@
 {
     "profileId": "microsoft-045e-065d",
-    "fallbackProfileIds": [ "generic-trigger-grip-touchpad-thumbstick"],
+    "fallbackProfileIds": [ "microsoft-045e-065d", "generic-trigger-grip-touchpad-thumbstick"],
     "layouts" : {
         "left-right" : {
             "selectSource": "xr-standard-trigger",

diff --git a/packages/registry/profiles/samsung/samsung-gearvr.json b/packages/registry/profiles/samsung/samsung-gearvr.json
@@ -2,7 +2,7 @@
     "profileId": "samsung-gearvr",
     "fallbackProfileIds": [ "generic-trigger-touchpad"],
     "layouts" : {
-        "none" : {
+        "left-right-none" : {
             "selectSource": "xr-standard-trigger",
             "components": {
                 "xr-standard-trigger": { "type": "trigger" },

diff --git a/packages/viewer/README.md b/packages/viewer/README.md
@@ -16,12 +16,12 @@ Per the [LICENSE.md](LICENSE.md) file, this repository is made available under a
 In general, this package should be built and tested from the root of the repository using the following command:
 > npm run test
 
-To build just this package invoke the following command from the root of the repository:
+To build just this package without running tests, invoke the following command from the root of the repository:
 > npm run build -- --scope @webxr-input-profiles/viewer
 
 ### Filing a bug
 Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-profiles/issues/52
 
 ### Filing a pull request
-Fill in the steps for filing a bug https://github.com/immersive-web/webxr-input-profiles/issues/52
+Fill in the steps for filing a pull request https://github.com/immersive-web/webxr-input-profiles/issues/52