diff --git a/README.md b/README.md index 19992e66a..84b276f22 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # Vuforia Spatial Edge Server -The Spatial Edge Server is the backbone of the Vuforia Toolbox system. Every +The Spatial Edge Server is the backbone of the Vuforia Spatial Toolbox system. Every device in the system, from an iPhone to an industrial robot arm, will run an instance of this server. This README outlines how to install the server on larger scale devices with command line access like laptops or desktops. Running on embedded devices may require more preparation. App-specific documentation -can be found in the [Vuforia Toolbox -iOS](https://github.com/ptcrealitylab/vuforia-toolbox-ios) or [Vuforia Toolbox -Android](https://github.com/ptcrealitylab/vuforia-toolbox-android) +can be found in the [Vuforia Spatial Toolbox +iOS](https://github.com/ptcrealitylab/vuforia-spatial-toolbox-ios) or [Vuforia Spatial Toolbox +Android](https://github.com/ptcrealitylab/vuforia-spatial-toolbox-android) repositories. ## Read First -The Vuforia Spatial Toolbox and Vuforia Spatial Edge Server make up a shared research platform for exploring spatial computing as a community. This research platform is not an out of the box production-ready enterprise solution. Please read the [MPL 2.0 license](LICENSE) before use. +The Vuforia Spatial Spatial Toolbox and Vuforia Spatial Edge Server make up a shared research platform for exploring spatial computing as a community. This research platform is not an out of the box production-ready enterprise solution. Please read the [MPL 2.0 license](LICENSE) before use. Join the conversations in our [discourse forum](https://forum.spatialtoolbox.vuforia.com) if you have questions, ideas want to collaborate or just say hi. @@ -24,13 +24,13 @@ software on Node 6, 8, and 10 with 10 being our recommended platform. Second, clone this repository into your desired directory: ```bash -git clone https://github.com/ptcrealitylab/vuforia-toolbox-server.git +git clone https://github.com/ptcrealitylab/vuforia-spatial-edge-server.git ``` -Next, enter the vuforia-toolbox-server directory and install all dependencies. +Next, enter the vuforia-spatial-edge-server directory and install all dependencies. ```bash -cd vuforia-toolbox-server +cd vuforia-spatial-edge-server npm install ``` @@ -42,7 +42,7 @@ cd addons git clone https://github.com/ptcrealitylab/vuforia-spatial-core-addon cd vuforia-spatial-core-addon npm install -cd ../.. # return to the main vuforia-toolbox-server directory +cd ../.. # return to the main vuforia-spatial-edge-server directory ``` You can now run the server using the following command: @@ -60,7 +60,7 @@ commit your changes, then GitHub will prompt you to make a pull request. ### Automated Tests Note that we do run some automated testing to ensure that our code remains consistently styled and functional. If you want to see the results of this -testing locally, run the following command in your vuforia-toolbox-server +testing locally, run the following command in your vuforia-spatial-edge-server folder: ```bash diff --git a/libraries/gitInterface.js b/libraries/gitInterface.js index 1c47ef8e6..79efc775d 100644 --- a/libraries/gitInterface.js +++ b/libraries/gitInterface.js @@ -3,7 +3,7 @@ var path = require('path'); var utilities = require('./utilities'); var identityFile = '/.identity/object.json'; -var homeDirectory = path.join(path.join(os.homedir(), 'Documents'), 'realityobjects'); +var homeDirectory = path.join(path.join(os.homedir(), 'Documents'), 'spatialToolbox'); var git = require('simple-git')(homeDirectory); diff --git a/libraries/hardwareInterfaces.js b/libraries/hardwareInterfaces.js index 473a6daa7..de7ac8b0a 100644 --- a/libraries/hardwareInterfaces.js +++ b/libraries/hardwareInterfaces.js @@ -76,7 +76,7 @@ function EmptyNode(nodeName, type) { */ /** - * @desc This function writes the values passed from the hardware interface to the RealityObjects server. + * @desc This function writes the values passed from the hardware interface to the spatial edge server. * @param {string} objectName The name of the RealityInterface * @param {string} nodeName The name of the IO point * @param {value} value The value to be passed on diff --git a/libraries/utilities.js b/libraries/utilities.js index ee221b89a..3731b4641 100644 --- a/libraries/utilities.js +++ b/libraries/utilities.js @@ -67,7 +67,7 @@ var path = require('path'); var hardwareInterfaces = {}; var identityFolderName = '.identity'; // TODO: get this from server.js -var homedir = path.join(path.join(os.homedir(), 'Documents'), 'realityobjects'); +var homedir = path.join(path.join(os.homedir(), 'Documents'), 'spatialToolbox'); var hardwareIdentity = homedir + '/.identity'; exports.writeObject = function (objectLookup, folder, id) { diff --git a/libraries/webFrontend.js b/libraries/webFrontend.js index b62e6dbba..c52497151 100644 --- a/libraries/webFrontend.js +++ b/libraries/webFrontend.js @@ -124,7 +124,7 @@ exports.printFolder = function (objects, objectsPath, debug, objectInterfaceName tempFiles.splice(0, 1); } - // populate the data for each object template on the frontend, using data from each directory found in the realityobjects + // populate the data for each object template on the frontend, using data from each directory found in the Spatial Toolbox tempFiles.forEach(function(objectKey) { var thisObjectKey = objectKey; diff --git a/libraries/webInterface/gui/index.html b/libraries/webInterface/gui/index.html index 478689caa..c5d32b8ea 100644 --- a/libraries/webInterface/gui/index.html +++ b/libraries/webInterface/gui/index.html @@ -77,7 +77,7 @@ To add some placeholder content, click on Add Frame, and give your frame a name.