Skip to content

Commit

Permalink
Updated readme usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Omar Khan committed Aug 31, 2011
1 parent 44dabc1 commit 47d56e0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -65,17 +65,17 @@ You can also install from source using cake. From the source directory, run:

CoffeeDoc can be run from the command line:

coffeedoc src/
Usage: coffeedoc [options] [targets]

or
Options:
-o, --output: Set output directory (default: ./docs)
--commonjs : Use if target scripts use CommonJS for module loading (default)
--requirejs : Use if target scripts use RequireJS for module loading (not yet implemented)

coffeedoc src/*.coffee

If you specify a directory, CoffeeDoc will recursively document all `.coffee`
If [targets] is a directory, CoffeeDoc will recursively document all `.coffee`
files found under that directory.

Generated documentation is saved to the `docs/` folder under the current
directory. If you wish to document several modules, make sure you generate all
If you wish to document several modules, make sure you generate all
the docs with a single command -- this ensures that they will all appear in the
`index.html` file.

Expand Down

0 comments on commit 47d56e0

Please sign in to comment.