Reko 开源项目使用教程

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

Reko 项目的目录结构如下：

reko/
├── AUTHORS
├── CMakeLists.txt
├── CONTRIBUTING.md
├── COPYING
├── COPYING.rtf
├── INSTALL
├── NEWS.md
├── README.md
├── TODO.md
├── ci/
│   └── github/
│       └── workflows/
├── doc/
├── external/
├── src/
├── subjects/
└── web/

目录结构介绍

• AUTHORS: 项目作者列表。
• CMakeLists.txt: CMake 构建配置文件。
• CONTRIBUTING.md: 贡献指南。
• COPYING: 项目许可证文件。
• COPYING.rtf: 项目许可证文件（RTF 格式）。
• INSTALL: 安装指南。
• NEWS.md: 项目更新日志。
• README.md: 项目介绍和使用说明。
• TODO.md: 项目待办事项。
• ci/: 持续集成相关文件。
  • github/workflows/: GitHub Actions 工作流配置文件。
• doc/: 项目文档。
• external/: 外部依赖库。
• src/: 项目源代码。
• subjects/: 测试用例和示例文件。
• web/: 项目相关网页资源。

2. 项目的启动文件介绍

Reko 项目包含多个启动文件，分别用于不同的用户界面和操作模式。以下是主要的启动文件介绍：

2.1 Windows GUI 启动文件

位于 src/Drivers/WindowsDecompiler/ 目录下：

• WindowsDecompiler.exe: Windows 图形用户界面启动文件。

2.2 命令行启动文件

位于 src/Drivers/CmdLine/ 目录下：

• CmdLine.exe: 命令行界面启动文件。

2.3 Avalonia GUI 启动文件

位于 src/Drivers/AvaloniaShell/ 目录下：

• AvaloniaShell.exe: 跨平台的 Avalonia 图形用户界面启动文件（仍在开发中）。

3. 项目的配置文件介绍

Reko 项目的配置文件主要用于构建和运行时的配置。以下是主要的配置文件介绍：

3.1 CMake 配置文件

• CMakeLists.txt: 用于 CMake 构建系统的配置文件，定义了项目的构建规则和依赖关系。

3.2 GitHub Actions 配置文件

位于 ci/github/workflows/ 目录下：

• cirrus.yml: GitHub Actions 工作流配置文件，用于自动化构建和测试。

3.3 项目许可证文件

• COPYING: 项目许可证文件，遵循 GNU General Public License (GPL-2.0)。
• COPYING.rtf: 项目许可证文件的 RTF 格式版本。

3.4 其他配置文件

• gitattributes: Git 属性配置文件，用于定义文件的 Git 行为。
• gitignore: Git 忽略配置文件，用于指定不需要 Git 跟踪的文件和目录。

通过以上介绍，您可以更好地理解和使用 Reko 开源项目。