From 34214405d53a0181c42a8235453810066eaae6b3 Mon Sep 17 00:00:00 2001 From: Michael Mathews Date: Sun, 27 Jun 2010 17:15:54 +0100 Subject: [PATCH] Added information of installing. --- LICENSE.md | 2 +- README.md | 35 +++++++++++++++++++++++++++-------- jsdoc.jar | Bin 1178 -> 0 bytes 3 files changed, 28 insertions(+), 9 deletions(-) delete mode 100644 jsdoc.jar 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 1c1c71d962c9973f41344e1303116c27ac58b9ea..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1178 zcmWIWW@h1H0D(;PSXqg#?R+19kIxU7Wac z;`=j93=FcY3=Et=7YCK*=_ThR78jR>WCvdk5U}0uTYX!gQoJYMVd)enmYQW9Oihb) z6*wX!(t9%54z(<~%;Nqx^w-h_Jw5aP2KH44%P}82ld`@1{m%6B_wIiAK3~3_!EJ+{ zv#b1ZU&-wS)~$7tkvu0(BpS5t=`rIer(Ec}e`cn1$_?V+A!25Ns|`>KtScIZE5 zlq<5CbdfXGjq$N>MGt46x{SZ%q{rK`*@byNzB!=PZ1Of#r^vePtx-v;dDrb@?#{(L z<-yT>S=)9;3K&#Ao17WSe7m@|&ojx;_PPmEo70s}jY%Cdn!I=TI87^y?bBqvTybo| zva1_jO4zB+3N+|`E~77U=Ar7!I~S_&X;!o<*9E6ZJ; zbX7zrVWQ&F&YUypx%6gZ0@EoV>|I&dx4kJEbnPV z9Mn2Kt7*H2u*srh#++hyInikaXFP8`7xQ~Jb>UMH3*A@g8TYm{eMrA(yn>0%)H=YX zJu4@0p3f6DXW@xDk^8ns8?U^$_h!dE6Q^~e8QR`Q4}H8Vw^q`^P)F*ZnDg_Qf7Dgg z{;Wz4j{O_>Wa9KmolckLEIk}zdRleclEAf5d98^r{?GcKYdmo|(|SQA*SOr^+aLGc z=u6Ic)RKSgP1XX|dCz~$+MjCK7slltf9f139pb*IFJrhEJQ+&;bj;+ z4NUhyAi(g}5k$i?EhK-#v|`WUAPpd}q){74!nGphcZB5-6VP)USUcE+yFe12{{p;O Q*+5dvK)3}+Utk9D0BtwUhyVZp