Installation Instructions

[kmiklas]

Thanks for your hard work on this template.

Some installation instructions would be really helpful. I keep getting module not found errors thrown, probably because I just don't have things in the right place, and I don't know where to put them.

Specifically, starting from the "jsdoc3Template-master.zip" download, where should things be placed?

Thanks

[danyg]

• You should to create a directory jsdoc3 for example
• Extract the content of the jsdoc3-master (https://github.com/jsdoc3/jsdoc)
• create 2 directories, jsdoc3/src and jsdoc3/doc, src is the place when you copy the source of your application, doc is the directory when the jsdoc3 pull the documentation. The structure of this directories must be:
  • doc/[PROJECT_NAME]
  • src/[PROJECT_NAME]/package.json
  • src/[PROJECT_NAME]/src (here you must put your code)
• Create a batch file (you have some examples in the README.md)
• run the batch file

Sorry for the wait.

[sadhasivam]

looks like nodepath is deprecated. causing some issues with windows.

[danyg]

A bundle standalone with the template and a jsdoc3 that works for it. https://github.com/danyg/jsdoc3Template/wiki/jsdoc.rar