Skip to content

Commit da6a5c1

Browse files
author
Matt Karl
committed
Update README.md
1 parent 156c209 commit da6a5c1

File tree

1 file changed

+68
-1
lines changed

1 file changed

+68
-1
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,71 @@
11
SpringRollStudio
22
============
33

4-
Application for SpringRoll projects
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.
5+
6+
**Features**
7+
* Manage a captions library
8+
* Remote debugging over a network
9+
* Run Grunt tasks for SpringRoll projects
10+
* Scaffold a new project with support for custom templates
11+
12+
## Dependencies
13+
14+
In order to build SpringRollStudio, there are some external global dependencies that are required.
15+
16+
### grunt
17+
18+
Grunt is required to build. See the [getting started guide](http://gruntjs.com/getting-started).
19+
20+
```bash
21+
npm install -g grunt-cli
22+
```
23+
24+
### makensis
25+
26+
[makensis](http://nsis.sourceforge.net/Main_Page) is required to create the Windows setup executable. Can be installed with [brew](http://brew.sh/):
27+
28+
```bash
29+
brew install makensis
30+
```
31+
32+
### appdmg
33+
34+
[node-appdmg](https://github.com/LinusU/node-appdmg) is required to create the OS X DMG installer image.
35+
36+
```bash
37+
npm install -g appdmg
38+
```
39+
40+
### wine
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/)
43+
44+
```bash
45+
brew install wine
46+
```
47+
48+
## Building
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:
51+
52+
Task | Description
53+
---|---
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
58+
59+
### Examples
60+
61+
Build SpringRollStudio in debug mode and run:
62+
63+
```bash
64+
grunt app-debug open
65+
```
66+
67+
Build SpringRollStudio and package to installers:
68+
69+
```bash
70+
grunt app package
71+
```

0 commit comments

Comments
 (0)