diff --git a/LICENSE.md b/LICENSE.md index fd9407a6..4a179b9e 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -3,7 +3,7 @@ License JSDoc 3 is free software. -Copyright 2010 (c) Michael Mathews +Copyright (c) 2010 Michael Mathews Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may diff --git a/README.md b/README.md index 5dd33a0e..a18a8d01 100644 --- a/README.md +++ b/README.md @@ -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: +Project Wiki: License ------- -JSDoc Toolkit Version 3 is copyright 2010 -(c) Michael Mathews +JSDoc 3 is copyright (c) 2010 Michael Mathews -See file "LICENSE.md" in this distribution for more details about terms of use. \ No newline at end of file +See file "LICENSE.md" in this distribution for more details about +terms of use. \ No newline at end of file diff --git a/jsdoc.jar b/jsdoc.jar deleted file mode 100644 index 1c1c71d9..00000000 Binary files a/jsdoc.jar and /dev/null differ