summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorDavid Siaw <[email protected]>2019-08-26 02:08:33 +0900
committerDavid Siaw <[email protected]>2019-08-26 02:08:33 +0900
commit6375639917a913c542967b33be01003a2b67c144 (patch)
tree644a637d60bfc1c7cd2fd2bb657a08bf5dc397b5 /README.md
parente1e96c0cf480930f33dcb4355f38244319ce0e37 (diff)
downloadmruby-6375639917a913c542967b33be01003a2b67c144.tar.gz
mruby-6375639917a913c542967b33be01003a2b67c144.zip
fix lots of warnings and make logo not so big
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 863560ebc..ec3492530 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,19 @@ Or
$ ruby ./minirake test
+## Building documentation
+
+There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen)
+
+To build both of them, simply go
+
+ rake doc
+
+You can also view them in your browser
+
+ rake view_api
+ rake view_capi
+
## How to customize mruby (mrbgems)
mruby contains a package manager called *mrbgems*. To create extensions