Permalink
Browse files

added '--help' to README

  • Loading branch information...
1 parent 8ada3e5 commit 2f3b90e9b05e552d44c6265171406f5756fe7c48 @bkidwell committed Jan 29, 2012
Showing with 7 additions and 0 deletions.
  1. +3 −0 README.html
  2. +4 −0 README.md
View
@@ -58,6 +58,9 @@ <h2 id="usage">Usage</h2>
<p><strong>Extract an existing mdepub Epub file's source</strong> into a directory under the current directory (so you can edit and repackage it):</p>
<pre><code>mdepub extract ~/Path/Filename.epub
</code></pre>
+<p><strong>Get all command line help</strong>:</p>
+<pre><code>mdepub --help
+</code></pre>
<h2 id="starting-your-markdown-source-file">Starting Your Markdown Source File</h2>
<p>Metadata for the compiled Epub file is specified in <code>options.yaml</code>. See <code>doc/options.html</code> for details.</p>
<p>mdepub assumes the entire ebook source text is contained in a single <code>.md</code>. Stylesheet information is given in a <code>.css</code> file with the same name. Any attached images can be included in an <code>images/</code> subdirectory in your project; be sure you link to the images in your source using relative paths, for example <code>images/author.jpg</code>.</p>
View
@@ -94,6 +94,10 @@ the current directory (so you can edit and repackage it):
mdepub extract ~/Path/Filename.epub
+**Get all command line help**:
+
+ mdepub --help
+
## Starting Your Markdown Source File

0 comments on commit 2f3b90e

Please sign in to comment.