Skip to content

Commit

Permalink
new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
houqp committed Feb 7, 2012
1 parent edc8d9b commit 0eb8c45
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Dependencies
------------

* AsciiDoc
* Deck.js (already included in this repo)
* Deck.js

Optional:

Expand All @@ -18,7 +18,9 @@ Optional:
Installation
------------

All you need to do is to make sure your asciidoc can properly find `deckjs.conf`. For asciidoc's configuration file loading strategy, please refer to [this guide](http://www.methods.co.nz/asciidoc/userguide.html#X7).
If you don't have deck.js you can download it automatically with `make install`. Or you can get it manually from its official [link](https://github.com/imakewebthings/deck.js/zipball/stable), and rename the unzipped directory to `deck.js`.

The second thing you need to do is to make sure your asciidoc can properly find `deckjs.conf`. For asciidoc's configuration file loading strategy, please refer to [this guide](http://www.methods.co.nz/asciidoc/userguide.html#X7).

The easiest way is to put `deckjs.conf` and the asciidoc file you wrote in the same directory.

Expand All @@ -32,4 +34,6 @@ asciidoc -f deck.js.conf file.asciidoc

file.asciidoc is the asciidoc file you wrote.

Remember to put `deck.js` and generated slide into the same directory.


0 comments on commit 0eb8c45

Please sign in to comment.