Skip to content

Commit

Permalink
Add README.
Browse files Browse the repository at this point in the history
  • Loading branch information
etodd committed Feb 15, 2016
1 parent 81ca494 commit f1b0e01
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Dialogger
=========

[![Dialogger](http://i.imgur.com/ojQbysnl.png)](http://i.imgur.com/ojQbysn.png)

Dialogger is a simple dialogue graph editor. It saves your dialogue graph in
two file formats:

- **.dl** - JSON file including all visual layout information
- **.dlz** - optimized JSON, easier and faster to parse

It uses [NW.js](http://nwjs.io/) and [JointJS](http://www.jointjs.com/).

Read more about the rationale
[here](http://etodd.io/2014/05/16/the-poor-mans-dialogue-tree/).

Running
-------

Binaries are provided, but if you want to hack on the project, first download
the NW.js SDK, then:

```shell
cd /path/to/app
/path/to/nwjs/nw .
```

See the [NW.js docs](http://docs.nwjs.io/) for more info.

The MIT License
---------------

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

0 comments on commit f1b0e01

Please sign in to comment.