urso avatar urso committed 108e33c

added documentation building info to README

Comments (0)

Files changed (1)

 TODO:
 =====
 - start some kind of documentation
-- add jsdoc toolkit markup for API documentation
+
+Build Documentation:
+====================
+In order to build the documentation you will need:
+- jsdoc toolkit (http://code.google.com/p/jsdoc-toolkit/). 
+  It is recommended to set the JSDOCDIR environment variable
+- jsdoc simple template (http://github.com/urso/jsdoc-simple):
+  just copy 'jsdoc-simple' directory to jsdoc toolkit's template directory
+- pandoc:
+  used to preprocess statis documentation files. Alternatively you can use any
+  other markdown preprocessor and update jsdoc.conf to use that preprocessor
+  instead of pandoc.
+- run './mkdoc' shell command (needs *nix shell).
+
 
 qc.js was originally written by Darrin Thompson with extensive contributions
 from Steffen Siering.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.