Rubyboy 项目使用教程

1. 项目的目录结构及介绍

Rubyboy 是一个使用 Ruby 编写的 Game Boy 模拟器。以下是项目的目录结构及各部分功能介绍：

rubyboy/
├── bin/                # 存放可执行文件
├── docs/               # 存放项目文档
├── exe/                # 存放执行文件
├── lib/                # 存放 Ruby 类库
├── resource/           # 存放资源文件，如 ROM 文件
├── sig/                # 存放签名文件
├── spec/               # 存放测试文件
├── .github/            # 存放 GitHub 工作流配置文件
├── .gitignore          # 定义 Git 忽略文件列表
├── .rspec              # RSpec 配置文件
├── .rubocop.yml        # RuboCop 配置文件
├── CHANGELOG.md        # 记录项目更新历史
├── CODE_OF_CONDUCT.md  # 定义项目行为准则
├── Gemfile             # 定义项目依赖
├── Gemfile.lock        # 锁定项目依赖版本
├── LICENSE.txt         # 项目许可证文件
├── README.md           # 项目说明文件
├── Rakefile            # Rake 任务配置文件
└── rubyboy.gemspec     # 项目宝石描述文件

2. 项目的启动文件介绍

项目的启动文件为 bin/rubyboy。该文件是 Rubyboy 模拟器的入口点，负责解析命令行参数，并启动模拟器。

#!/usr/bin/env ruby

require_relative '../lib/rubyboy'

def main(rom_path)
  emulator = Rubyboy::Emulator.new(rom_path)
  emulator.run
end

if __FILE__ == $PROGRAM_NAME
  rom_path = ARGV.first
  unless rom_path
    puts "Usage: #{$PROGRAM_NAME} <rom_path>"
    exit 1
  end

  main(rom_path)
end

3. 项目的配置文件介绍

以下是项目中几个重要配置文件的简要介绍：

• .rubocop.yml: RuboCop 配置文件，用于定义 Ruby 代码风格规范。通过该文件，可以确保项目代码遵循一致的编码风格。

• .rspec: RSpec 配置文件，用于定义 RSpec 测试框架的行为。该文件包括测试文件的路径、测试选项等。

• Gemfile 和 Gemfile.lock: 这两个文件用于管理项目依赖。Gemfile 定义了项目所需的 Ruby 库，而 Gemfile.lock 锁定了项目依赖的具体版本，确保在不同环境中能够一致地安装依赖。

• Rakefile: Rake 任务配置文件，用于定义 Rake 任务，如测试、构建等。通过 Rake，可以简化项目的构建和部署过程。