Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
lazerwalker committed Jan 31, 2016
1 parent 9111bf7 commit 550d19b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
@@ -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.

0 comments on commit 550d19b

Please sign in to comment.