mrubook

A documentation about mruby internals. https://syucream.github.io/mrubook/

Note

This doc contains a part of the mruby source code published under the MITL.

Formats

filename

Basically name a doc file related to a mruby src/ file.

Doc format

I adopt reStructuredText as each doc file format.

Each doc style is here:

<Title>
######################

Overview
**********

...


Details
********

...

APIs(if its needed)
********************

...

Contributing

1. Add or update docs based on above rules.
2. Create PullRequest.

License

MITL