Skip to content

Commit

Permalink
Updated README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
toolness committed Sep 23, 2011
1 parent 18dc1e0 commit 881dd9a
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
Quickpreso is an attempt to make prototyping presentations be more like prototyping HTML pages.

Whether this is a good idea remains to be seen.
Whether this is a good idea remains to be seen.

## Requirements ##

To generate presentations, you need:

* OS X 10.6 or higher
* [ffmpeg][]

The generated presentations use [Popcorn.js][] for syncing audio to video content. Currently, the audio is only produced in Ogg Vorbis format, so only Firefox and Chrome can be used to view presentations.

[ffmpeg]: http://ffmpeg.org/
[Popcorn.js]: http://popcornjs.org/

## Quick Start ##

1. Edit the [script.html][] to your liking. Each plain-text line is text to be narrated, while all HTML elements are slides that the narration voices over.

2. Run `python quickpreso.py`. This will use OS X's `say` command-line tool to automatically generate audio for your narration and `ffmpeg` to convert the final audio to Ogg Vorbis. It also generates information about where slide changes occur in the narration.

3. View [index.html][] in Firefox or Chrome.

4. Repeat steps 1-3 as necessary until you're happy with your presentation. When you're finished, just upload everything in the `static-files` directory to a web server.

[script.html]: https://github.com/toolness/quickpreso/blob/master/static-files/script.html
[index.html]: https://github.com/toolness/quickpreso/blob/master/static-files/index.html

0 comments on commit 881dd9a

Please sign in to comment.