Skip to content

Latest commit

History

History
59 lines (57 loc) 路 2.42 KB

File metadata and controls

59 lines (57 loc) 路 2.42 KB

The mruby directory structure

+- 馃拵 mruby/                    The top directory of mruby.
    |
    +- 馃搧 .github/              GitHub configuration files for mruby project management.
    |
    +- 馃搧 benchmark/            Benchmarking files for mruby.
    |
    +- 馃搧 bin/                  Links to temporary executables after build. Auto-created.
    |
    +- 馃搧 build/                Default build output destination for mruby. Auto-created.
    |   |
    |   +- 馃搧 repos/            The git clone destination directory for GEMs that depend on the build configuration.
    |   |
    |   +- 馃搧 host/             The "host" build output directory.
    |
    +- 馃搧 build_config/         Build configuration files for various environments.
    |
    +- 馃搧 doc/                  Documentation for mruby.
    |   |
    |   +- 馃搧 guides/           Documentation for general users.
    |   |
    |   +- 馃搧 internal/         Documentation for internal implementations for developers.
    |
    +- 馃搧 examples/             Examples of mruby usages.
    |   |
    |   +- 馃搧 mrbgems/          Examples for creating custom GEM for mruby.
    |
    +- 馃搧 include/              C header files required when using mruby.
    |
    +- 馃搧 lib/                  Ruby scripts used for building mruby.
    |
    +- 馃搧 mrbgems/              A library collection of features not provided by mruby core only.
    |   |                       See doc/guides/mrbgems.md file
    |   |
    |   +- 馃搧 mruby-*/          The directory of each GEMs.
    |   |
    |   +- 馃搩 *.gembox          A collection of GEMs grouped by features and purposes.
    |
    +- 馃搧 mrblib/               The core Ruby scripts that makes up the main body of mruby.
    |
    +- 馃搧 oss-fuzz/             Source code for The fuzzing-test.
    |                           See https://github.com/google/oss-fuzz
    |
    +- 馃搧 src/                  The core C source code that makes up the main body of mruby.
    |
    +- 馃搧 tasks/                Rake tasks at build-time.
    |   |
    |   +- 馃搧 toolchains/       Definitions for the compiler, linker, archiver, etc. for each toolchain.
    |
    +- 馃搧 test/                 Ruby scripts needed for testing mruby.
    |   |
    |   +- 馃搧 t/                mruby test cases.
    |
    +- 馃搧 tools/                Helper scripts used when building mruby.