Update API documentation related notes.

msgpack · Oct 6, 2013 · f5a6ec5 · f5a6ec5
1 parent b7131c3
commit f5a6ec5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/BuildNote.txt b/BuildNote.txt
@@ -16,4 +16,6 @@ How to Build Help Files
   1. Open "MsgPack.shfbproj" with SandCastle Help File Builder.
   2. Build it.
   3. Copy contents under `Help/` directory to `apidoc/` of `gh-pages` branch without `*.chm` files.
-  4. Copy `*.chm` files to `dist/` of `gh-pages` branch.
+  4. Rename `index.html` to `top.html` because gh-pages does not allow index.* file.
+  5. Remove other `index.*` files.
+  6. Copy `*.chm` files to `dist/` of `gh-pages` branch.
diff --git a/README.md b/README.md
@@ -63,7 +63,8 @@ Open MsgPack.mono.sln with MonoDevelop and then click **Build** menu item.
 ## See also
 
 *  GitHub Page           : http://cli.msgpack.org/
-*  Wiki                  : https://github.com/msgpack/msgpack-cli/wiki
+*  Wiki (documentation)  : https://github.com/msgpack/msgpack-cli/wiki
+*  API Reference         : http://cli.msgpack.org/doc/top.html
 *  Issue tracker         : https://github.com/msgpack/msgpack-cli/issues
 *  MSBuild reference     : http://msdn.microsoft.com/en-us/library/0k6kkbsd.aspx
 *  Mono xbuild reference : http://www.mono-project.com/Microsoft.Build