Mirah 技术文档

本文档旨在帮助用户了解并使用 Mirah 项目，包括安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

Ruby 安装方式

如果你的 gem 和 rake 不是来自 JRuby，请在命令前加上 jruby -S。

$ gem install mirah

JAR 安装方式

Mirah 通过 Maven 中央仓库作为 JAR 包分发。你可以从 maven.org 下载最新的 JAR 包。

ZIP 安装方式

你也可以从 ZIP 文件安装 Mirah。从 GitHub 发布页面 下载最新稳定的发布版本，解压后，将 bin 目录添加到你的 $PATH 环境变量中，以便使用 mirah、mirahc 等命令。

源代码安装方式

本地设置构建并从源代码安装，你需要 jruby 1.7.12 或更高版本。然后只需按照以下命令操作。

获取仓库到本地

$ git clone http://github.com/mirah/mirah.git
$ cd mirah
$ bundle install

从源代码安装 Mirah 为 gem

$ rake gem
$ gem install pkg/mirah-*.gem

创建 mirahc JAR 包

$ rake dist/mirahc.jar

这将创建一个 mirahc.jar 文件在 dist 目录中，你可以运行它来编译 Mirah 源文件。

2. 项目的使用说明

Mirah 是一种具有静态类型、局部类型推断和深受 Ruby 语法启发的自定义编程语言。Mirah 目前包括一个针对 JVM 的类型器/编译器后端，可以输出 JVM 字节码。

使用 Mirah 的基本命令如下：

mirah <script.mirah>
mirah -e "inline script"
mirahc <script.mirah>
mirahc -e "inline script" # 生成 DashE.class

3. 项目 API 使用文档

Mirah 的 API 文档详细介绍了各种类型、方法和模块的使用。由于项目文档是动态生成的，你可以通过以下命令获取最新的 API 文档：

$ rake doc

这将生成 API 文档在 doc 目录中。

4. 项目安装方式

请参考上述“安装指南”部分，了解不同安装方式的具体步骤。