Skip to content

Commit 5cd0d98

Browse files
author
Matt Karl
committed
Update README.md
1 parent c68e389 commit 5cd0d98

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
SpringRollStudio [![Dependency Status](https://david-dm.org/SpringRoll/SpringRollStudio.svg)](https://david-dm.org/SpringRoll/SpringRollStudio)
22
============
33

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.
55

66
**Features**
77
* Manage a captions library
@@ -37,35 +37,45 @@ brew install makensis
3737
npm install -g appdmg
3838
```
3939

40-
### wine
40+
### xquarts & wine
4141

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/)
4343

4444
```bash
4545
brew install wine
4646
```
4747

4848
## Building
4949

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:
5157

5258
Task | Description
5359
---|---
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
5864

5965
### Examples
6066

61-
Build SpringRollStudio in debug mode and run:
67+
Build SpringRollStudio in debug mode for OS X run:
6268

6369
```bash
64-
grunt app-debug open
70+
grunt app-debug:osx64 open:osx64
6571
```
6672

67-
Build SpringRollStudio and package to installers:
73+
Build SpringRollStudio for all platforms and package for all using:
6874

6975
```bash
7076
grunt app package
7177
```
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

Comments
 (0)