Added information of installing.

This commit is contained in:
Michael Mathews 2010-06-27 17:15:54 +01:00
parent 0c577940df
commit 34214405d5
3 changed files with 28 additions and 9 deletions

View File

@ -3,7 +3,7 @@ License
JSDoc 3 is free software.
Copyright 2010 (c) Michael Mathews <micmath@gmail.com>
Copyright (c) 2010 Michael Mathews <micmath@gmail.com>
Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this software except in compliance with the License. You may

View File

@ -1,23 +1,42 @@
JSDoc Toolkit Version 3
=======================
JSDoc 3
=======
This is pre-release software, under active development. It is not intended for
general use.
This is pre-release software, under active development. It is not
intended for general use.
Install
-------
To build the jar file that runs JSDoc 3 use the ant build tool.
$ cd ./java
$ 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:
$ cd ..
$ java -jar jsdoc.jar -T
Usage
-----
This example assumes your working directory is the JSDoc 3 project
base directory...
$ java -jar jsdoc.jar -d jsdoc.json myscript.js
See
---
Project Wiki: <http://code.google.com/p/jsdoc-toolkit-3/w/list>
Project Wiki: <http://code.google.com/p/jsdoc/w/list>
License
-------
JSDoc Toolkit Version 3 is copyright 2010
(c) Michael Mathews <micmath@gmail.com>
JSDoc 3 is copyright (c) 2010 Michael Mathews <micmath@gmail.com>
See file "LICENSE.md" in this distribution for more details about terms of use.
See file "LICENSE.md" in this distribution for more details about
terms of use.

BIN
jsdoc.jar

Binary file not shown.