archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Update to readme.

Browse Source
This commit is contained in:
Michael Mathews 2011-01-22 23:58:26 +00:00
parent 9a4a23d329
commit 6b25e91bb0
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,15 +9,16 @@ Install
To build the jsdoc jar that runs JSDoc 3, use the ant build tool.
$ cd JSDoc
$ ant
git clone git://github.com/micmath/jsdoc.git jsdoc
cd jsdoc
ant
This will create a file name `jsdoc.jar` in the project base
directory.
To test that the installed app is working, execute the following:
$ java -jar jsdoc.jar --test
java -jar jsdoc.jar --test
Usage
-----
@ -25,21 +26,21 @@ Usage
This example assumes your working directory is the JSDoc project
base directory...
$ java -jar jsdoc.jar yourSourceCodeFile.js
java -jar jsdoc.jar yourSourceCodeFile.js
For help regarding the supported commandline options use -h.
$ java -jar jsdoc.jar --help
java -jar jsdoc.jar --help
See
---
Project Wiki: <http://code.google.com/p/jsdoc/w/list>
Project Documentation: <http://micmath.github.com/jsdoc>
License
-------
JSDoc 3 is copyright (c) 2010 Michael Mathews <micmath@gmail.com>
JSDoc 3 is copyright (c) 2011 Michael Mathews <micmath@gmail.com>
See file "LICENSE.md" in this distribution for more details about
terms of use.