|
1 | 1 | SpringRollStudio [](https://david-dm.org/SpringRoll/SpringRollStudio) |
2 | 2 | ============ |
3 | 3 |
|
4 | | -SpringRollStudio is an native application (build with [nw-init](https://github.com/CloudKidStudio/nw-init) and designed to provide graphic user interfaces for building and managing [SpringRoll](https://github.com/SpringRoll/SpringRoll) projects. |
| 4 | +SpringRollStudio is an native application (build with [NW.js](http://nwjs.io/) and designed to provide graphic user interfaces for building and managing [SpringRoll](https://github.com/SpringRoll/SpringRoll) projects. |
5 | 5 |
|
6 | 6 | **Features** |
7 | 7 | * Manage a captions library |
@@ -37,35 +37,45 @@ brew install makensis |
37 | 37 | npm install -g appdmg |
38 | 38 | ``` |
39 | 39 |
|
40 | | -### wine |
| 40 | +### xquarts & wine |
41 | 41 |
|
42 | | -On OSX if building for Windows, Wine needs to be installed to create the application icon. Can be installed with [brew](http://brew.sh/) |
| 42 | +On OSX if building for Windows, Wine needs to be installed to create the application icon. First install xquartz by downloading [here](http://xquartz.macosforge.org/landing/), then Wine can be installed with [Homebrew](http://brew.sh/) |
43 | 43 |
|
44 | 44 | ```bash |
45 | 45 | brew install wine |
46 | 46 | ``` |
47 | 47 |
|
48 | 48 | ## Building |
49 | 49 |
|
50 | | -The Grunt project is an extension of the [grunt-game-builder](https://github.com/CloudKidStudio/grunt-game-builder) and all those grunt tasks can be used on your app. In addition, there are several Grunt tasks that are specific and useful to building SpringRollStudio: |
| 50 | +Before building, make sure to run NPM install to import Node dependencies for building the project. |
| 51 | + |
| 52 | +```bash |
| 53 | +npm install |
| 54 | +``` |
| 55 | + |
| 56 | +The build tasks extend [project-grunt](https://github.com/CloudKidStudio/project-grunt) and all those Grunt tasks can be used when building SpringRoll Studio. In addition, there are several Grunt tasks that are specific and useful to building the [NW.js](http://nwjs.io/) app: |
51 | 57 |
|
52 | 58 | Task | Description |
53 | 59 | ---|--- |
54 | | -**app** | Builds a release version of the node-webkit app |
55 | | -**app-debug** | Builds a debug version of the node-webkit app |
56 | | -**package** | Create the OSX and Windows installers |
57 | | -**open** | Open the OSX application |
| 60 | +**app:(win32|win64|osx64|osx32)** | Builds a release version of the NW.js app, when no platform is specified, all platforms are built. |
| 61 | +**app-debug:(win32|win64|osx64|osx32)** | Builds a debug version of the NW.js app, when no platform is specified, all platforms are build in debug mode. |
| 62 | +**package:(win32|win64|osx64|osx32)** | Create the OSX and Windows installers, also optional platform |
| 63 | +**open:(win32|win64|osx64|osx32)** | Open the OSX application, also optional platform |
58 | 64 |
|
59 | 65 | ### Examples |
60 | 66 |
|
61 | | -Build SpringRollStudio in debug mode and run: |
| 67 | +Build SpringRollStudio in debug mode for OS X run: |
62 | 68 |
|
63 | 69 | ```bash |
64 | | -grunt app-debug open |
| 70 | +grunt app-debug:osx64 open:osx64 |
65 | 71 | ``` |
66 | 72 |
|
67 | | -Build SpringRollStudio and package to installers: |
| 73 | +Build SpringRollStudio for all platforms and package for all using: |
68 | 74 |
|
69 | 75 | ```bash |
70 | 76 | grunt app package |
71 | 77 | ``` |
| 78 | + |
| 79 | +### Known Issues |
| 80 | + |
| 81 | +* On OS X, building Windows 32-bit and 64-bit platforms back-to-back have been known to fail when using Wine to update the icon. The workaround is to build one platform at a time. |
0 commit comments