add README and local binary cl options

This commit is contained in:
Stephen Birarda 2015-12-03 11:40:28 -08:00
parent 8423f2c979
commit ea1c81ca0f
3 changed files with 40 additions and 0 deletions

25
console/README.md Normal file
View file

@ -0,0 +1,25 @@
### Console
The High Fidelity Desktop Console, made with [Electron](http://electron.atom.io/).
### Running Locally
Make sure you have [Node.js](https://nodejs.org/en/) installed. Use the latest stable version.
```
npm install
npm start
```
To run, the console needs a build of Interface, domain-server, and assignment-client.
The default, `npm start` tells the console to look for debug builds of those binaries in a build folder beside the console folder.
If you want to use release builds use `npm run local-release`.
### Packaging
CMake produces a target `package-console` that will bundle up everything you need for the console on your platform.
It ensures that there are available builds for the domain-server, assignment-client, and Interface. Then it produces an executable for the console.
Finally it copies all of the produced executables to a directory, ready for testing or packaging for deployment.

View file

@ -31,6 +31,18 @@ app.on('window-all-closed', function() {
}
});
// Check command line arguments to see how to find binaries
var argv = require('yargs');
if (argv.localDebugBuilds) {
// check in a dev folder structure for debug binaries
} else if (argv.localReleaseBuilds) {
// check in a dev folder structure for release binaries
} else {
// check beside the console application for the binaries
}
// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
app.on('ready', function() {

View file

@ -20,5 +20,8 @@
"start": "electron . --local-debug-builds",
"local-release": "electron . --local-release-builds",
"package-darwin": "electron-packager . Console --platform=darwin --arch=x64 --version=0.35.2"
},
"dependencies": {
"yargs": "^3.30.0"
}
}