From 6375639917a913c542967b33be01003a2b67c144 Mon Sep 17 00:00:00 2001
From: David Siaw <davidsiaw@gmail.com>
Date: Mon, 26 Aug 2019 02:08:33 +0900
Subject: fix lots of warnings and make logo not so big

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'README.md')

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
-- 
cgit v1.2.3