if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2024-12-27 01:11:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Lynn 2017-05-11 11:48:16 -07:00 committed by GitHub
parent 515ee36fe1
commit 4694e5206a
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -13,13 +13,15 @@ Our goal is to improve the performance and development agility of Symphony's des
In order to achieve those goals Symphony is participating and working in close collaboration with the [Foundation Desktop Wrapper Working Group](https://symphonyoss.atlassian.net/wiki/display/WGDWAPI/Working+Group+-+Desktop+Wrapper+API)
## Windows Dev Env
- For screen-snippet to work:
* MSBuild.exe must be in path. MSBuild.exe is available by installing Visual Studio 2017 Community.
* .NET3.5 SP1 must be installed.
* Note: screen-snippet is an optional dependency so if MSBuild.exe (Visual Studio) is not installed, then the install will still succeed, BUT the screen snippet functionality will not work on Windows.
- NodeJS version >= 7.4.0 (corresponds to electron 1.6.7) - needed to run tests locally
- NodeJS version >= 7.4.0 (corresponds to electron 1.6.7)
- install Microsoft Visual Studio 2015 with both C++ and .NET/C# development tools. Free community versions works.
- also make sure .NET3.5SP1 is installed.
- note: C++ tools needed to recompile node modules
- note: .NET/C# tools needed to compile screen-snippet
- open 'Developer Command Prompt for VS2015' - this sets paths to visual studio build tools
## Mac Dev Env
- need to install xcode command line tools.
- NodeJS version >= 7.4.0 (corresponds to electron 1.6.7) - needed to run tests locally
## Run demo:
@ -37,6 +39,9 @@ In order to achieve those goals Symphony is participating and working in close c
- to install for all users (admin required): msiexec.exe /i Symphony-x64.msi ALLUSERS=1
- to install per user: msiexec.exe /i Symphony-x64.msi ALLUSERS=""
- to change default pod url: msiexe.exe /i Symphony-x64.msi POD_URL=my.symphony.com
- to change auto start: msiexe.exe /i Symphony-x64.msi AUTO_START=true (or false) - if not specified default it true.
- to change minimize on close: msiexe.exe /i Symphony-x64.msi MINIMIZE_ON_CLOSE=true (or false) - if not specified default is true.
- any of the above options can be chained together, for example: msiexe.exe /i Symphony-x64.msi MINIMIZE_ON_CLOSE=true AUTO_START=false POD_URL=my.symphony.com
## Start URL
- To change the start url (i.e., pod url), edit config/Symphony.config and change 'url' variable. if no protocol provided, then https will be added.