Merge pull request #8 from symphonyoss/mindthegab-mission-readme

Updated Readme w/Project Goals per JC's guidance
This commit is contained in:
Lynn 2016-12-14 18:22:59 +00:00 committed by GitHub
commit 4131268b2f

View File

@ -1,6 +1,19 @@
# SymphonyElectron # SymphonyElectron
Instructions: Project Goals:
Our goal is to improve the performance and development agility of Symphony's desktop wrapper and build a path to support other wrappers by:
1. Standardizing the JS to native interfaces
2. Standardizing the app to app interfaces (current embedding API)
3. Provide an open and free reference implementation that anyone can contribute to, modify, and make derivative works.
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)
Build Instructions:
- to pick up dependencies: npm install - to pick up dependencies: npm install
- to locally run mac version: npm run dev:mac - to locally run mac version: npm run dev:mac
- to locally run windows (64 bit) version: npm run dev:win - to locally run windows (64 bit) version: npm run dev:win