Skip to content

Commit c2f7d45

Browse files
committed
quick update to readme
1 parent 46b82dd commit c2f7d45

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,51 @@
11
# springroll-studio
22

3+
Springroll Studio provides a convenient desktop application for creating and managing [Springroll](https://github.com/SpringRoll/SpringRoll) applications.
4+
5+
## Features
6+
7+
### Game Preview
8+
Springroll Studio has a built in [SpringrollContainer](https://github.com/SpringRoll/SpringRollContainer) environment that can load your game directly from your projects deploy folder or from a URL(local or otherwise), allowing you to test your game within the full Springroll environment.
9+
10+
### Project Templating
11+
Using the Create Project option you can download one of the [Springroll Seed Projects](https://github.com/SpringRoll/Springroll-Seed) and have a Springroll project set up and ready for development in seconds. PIXI, Phaser, and CreateJS versions are available.
12+
13+
### Caption Studio
14+
Caption Studio is designed to help you in creating audio caption files (JSON format) for use in Springroll projects. Caption Studio reads your project (or selected audio directory) for any appropriate audio files and allows you to select which files you want to caption. It features:
15+
- An interactable waveform of your audio file
16+
- A directory structure for easy file selection and searching
17+
- A Springroll caption renderer that will display your captions while the audio file is playing
18+
- A JSON preview that allows you to edit your caption JSON output directly. You can either save this JSON to your project, or export it as a file to download if you so choose.
19+
20+
###
21+
322
## Project setup
423
```
524
npm install
625
```
726

827
### Compiles and hot-reloads for development
928
```
10-
npm run serve
29+
npm run dev
1130
```
1231

1332
### Compiles and minifies for production
1433
```
15-
npm run build
34+
npm run electron:build
35+
```
36+
37+
After running this command you will find the application install files in the `build` directory. These can be run and/or installed in the same manner as any other desktop application.
38+
39+
### Testing
40+
```
41+
npm run test
1642
```
1743

1844
### Lints and fixes files
1945
```
2046
npm run lint
2147
```
2248

49+
2350
### Customize configuration
2451
See [Configuration Reference](https://cli.vuejs.org/config/).

0 commit comments

Comments
 (0)