Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9111bf7
commit 550d19b
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Storyboard-iOS | ||
|
||
This is the reference client for the [Storyboard](https://github.com/lazerwalker/storyboard.git) multilinear storytelling engine. Just like Storyboard itself, this is considered pre-alpha software and is not documented at all. | ||
|
||
|
||
## Setup and Usage | ||
|
||
This is not yet really intended for use by anyone other than myself. That being said: | ||
|
||
* This currently expects to exist as a submodule to Storyboard itself. Set this up by cloning Storyboard and running `git submodule init --update` | ||
* Specifically, it expects two things: a compiled `../dist.js` file, and a `../examples` folder containing projects. Any projects that exist there (with a `.json` file and optionally a folder of media assets with the same name as the JSON file) will show up if you hit the Search icon in-app. | ||
|
||
Knock yourself out. |