Permalink
Browse files

Merge remote-tracking branch 'origin/master' into dommy

Conflicts:
	.gitignore
  • Loading branch information...
2 parents 702edce + 80ec40c commit b2c59e49854b04ab703694c0ef51758d9e95cb38 @jeremyBanks jeremyBanks committed May 30, 2012
View
@@ -7,3 +7,10 @@
# LibreOffice
.~*#
+
+# nodeenv
+nodeenv/
+node_modules/
+
+# cornfield
+view/
View
@@ -0,0 +1,6 @@
+[submodule "external/popcornjs"]
+ path = external/popcornjs
+ url = https://github.com/mozilla/popcorn-js.git
+[submodule "external/butter"]
+ path = external/butter
+ url = https://github.com/mozilla/butter.git
View
@@ -1,9 +1,65 @@
Slide-drive
===========
-[Slide-drive](https://github.com/dseif/slide-drive) is a HTML5 slideshow player that enables audio or video to control a [Deck.js](http://imakewebthings.github.com/deck.js/) slideshow. The author needs nothing more than a basic understanding of HTML and CSS to make a fully featured slideshow.
+[Slide-drive][slide-drive] is a HTML5 slideshow player that enables audio or video to control a [Deck.js][deck.js] slideshow. The author needs nothing more than a basic understanding of HTML and CSS to make a fully featured slideshow.
+
+Getting Started
+---------------
+
+### Clone the repo and externals
+
+(This currently clones hundreds of megs of unnecessary or redundant data.)
+
+ $ git clone https://github.com/jeremybanks/slide-drive.git slide-drive
+ $ cd slide-drive
+ $ git submodule update --init --recursive
+
+#### To update, assuming no modifications were made
+
+ $ git pull origin master
+ $ git submodule update --init --recursive
+
+### Setup Node.js and its modules
+
+Butter requires [Node.js][node.js] v0.6 or higher. You may use your system's copy, but I prefer to install an isolated copy using the Python tool [nodeenv][nodeenv]. This takes longer to install but is more difficult to break.
+
+#### Install it using you Python package manager of choice
+
+ $ pip install nodeenv
+ # OR
+ $ easy_install nodeenv
+
+#### Create local node installation
+
+ $ python -m nodeenv --node=0.7.9 --npm=1.1.23 nodeenv
+
+#### Install Butter's dependencies using NPM:
+
+ $ nodeenv/bin/npm install external/butter/
+ $ nodeenv/bin/npm install shelljs express stylus mongoose express-browserid
+
+### Install and Run MongoDB
+
+Some basic functionality doesn't require [MongoDB][mongodb], but it is required to save or share pages. You're on your own for installing this.
+
+ $ screen -d -m mongod
+
+### Start the Butter/Cornfield server
+
+ $ NODE_PATH=external_configs/cornfield nodeenv/bin/node external/butter/cornfield/app
+
+### Open it!
+
+Load <http://localhost:8888/template.html> to view the Slide Drive template for Butter, or <http://localhost:8888/> to see an example Slide Drive presentation.
+
+ [slide-drive]: https://github.com/jeremybanks/slide-drive
+ [deck.js]: http://imakewebthings.com/deck.js/
+ [node.js]: http://nodejs.org/
+ [nodeenv]: http://ekalinin.github.com/nodeenv/
+ [mongodb]: http://www.mongodb.org/
Keyboard commands
-----------------
+
* play or pause: p
* next slide: spacebar, right arrow, up arrow
* previous slide: backspace, left arrow, down arrow
Submodule butter added at ec52b6
Submodule popcornjs added at 4cb0cc
Oops, something went wrong.

0 comments on commit b2c59e4

Please sign in to comment.