Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add "how to build the doc ?"

  • Loading branch information...
commit 8f2b027f86274555072d5ce007dc5f52d0cb8c8f 1 parent 0bfcb11
@romac romac authored
Showing with 17 additions and 1 deletion.
  1. +17 −1 README.md
View
18 README.md
@@ -1,8 +1,24 @@
# the ooc language
-In progress, send feedback to amos@ofmlabs.org and mention 'ooc' in the subject.
+## status
+
+**In progress**, send feedback to amos@ofmlabs.org and mention 'ooc' in the subject.
Thanks a lot =)
Amos Wenger aka [@nddrylliog](http://twitter.com/nddrylliog)
+
+## how to build the doc ?
+
+Easy,
+
+ $ make
+
+will generate a single-page, HTML version of the documentation.
+
+Then,
+
+ $ make publish
+
+will switch to the `gh-pages` branch, commit the modifications and push the commits to `origin` (which may be your forked repository).
Please sign in to comment.
Something went wrong with that request. Please try again.