https://github.com/syucream/mrubook

mruby internals and handbook, in Japanese(currently)
https://github.com/syucream/mrubook

mruby

Last synced: 8 months ago
JSON representation

mruby internals and handbook, in Japanese(currently)

• Host: GitHub
• URL: https://github.com/syucream/mrubook
• Owner: syucream
• License: mit
• Created: 2016-08-14T08:13:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-01T17:06:10.000Z (almost 9 years ago)
• Last Synced: 2025-03-31T16:58:44.679Z (10 months ago)
• Topics: mruby
• Language: C++
• Homepage: https://syucream.github.io/mrubook/
• Size: 2.22 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

```rst

######################

Overview

**********

...

Details

********

...

APIs(if its needed)

********************

...

```

# Contributing

1. Add or update docs based on above rules.

2. Create PullRequest.

# License

MITL