Permalink
Browse files

[doc] opadoc: added some explainations in the README

  • Loading branch information...
1 parent 6a50c62 commit f3cd342d7359a35084d061404acb5e4012ed8626 @Aqua-Ye Aqua-Ye committed Oct 7, 2011
Showing with 17 additions and 0 deletions.
  1. +17 −0 opadoc/README
View
@@ -34,3 +34,20 @@ open doc/index.html and enjoy !
In general:
# opadoc FILE.opa* DIR* -o directory
# open directory/index.html
+
+
+
+
+HOW TO BUILD DOC:
+
+First you need to compile opalang with api files:
+ cd $(OPALANG)
+ make all packages-api
+
+Then generate the HTML documentation:
+- cd $(OPALANG)/opadoc
+- opa opadoc.opack
+- considering DOC_PATH=static_doc and DOCS=$(OPALANG)/_build/stdlib
+- _build/generator/opaDoc/opaDoc.exe -o $(DOC_PATH) $(DOCS)
+- your doc should be in $(DOC_PATH)
+- open $(DOC_PATH)/index.html in your favorite browser

0 comments on commit f3cd342

Please sign in to comment.