Kalyn 项目使用教程

Kalyn 项目使用教程

kalyn ⚗️ Self-hosting compiler from a Haskell-like Lisp directly to x86-64, from scratch. 项目地址: https://gitcode.com/gh_mirrors/ka/kalyn

1. 项目目录结构及介绍

Kalyn 项目的目录结构如下：

kalyn/
├── app/
├── scripts/
├── src-kalyn/
├── src/
├── .gitignore
├── LICENSE.md
├── Makefile
├── README.md
├── Setup.hs
├── hie.yaml
├── kalyn-mode.el
├── module-map.png
├── package.yaml
├── stack.yaml
├── stack.yaml.lock

目录介绍

• app/: 存放应用程序的主要代码文件。
• scripts/: 存放项目的脚本文件，可能包括构建、测试等脚本。
• src-kalyn/: 存放 Kalyn 编译器的源代码。
• src/: 存放项目的源代码文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE.md: 项目的许可证文件，通常包含 MIT 许可证。
• Makefile: 项目的 Makefile 文件，用于自动化构建和编译。
• README.md: 项目的说明文件，包含项目的概述、安装和使用说明。
• Setup.hs: Haskell 项目的设置文件。
• hie.yaml: Haskell IDE 引擎的配置文件。
• kalyn-mode.el: Emacs 编辑器的模式配置文件。
• module-map.png: 模块关系图。
• package.yaml: Stack 项目的配置文件。
• stack.yaml: Stack 构建工具的配置文件。
• stack.yaml.lock: Stack 构建工具的锁定文件，确保依赖版本一致。

2. 项目启动文件介绍

Kalyn 项目的启动文件主要是 Makefile 和 Setup.hs。

Makefile

Makefile 是项目的构建文件，包含了项目的编译、运行等命令。以下是一些关键命令：

• make 1: 编译 Haskell 实现，生成中间日志文件。
• make 2: 使用 Haskell 实现编译 Kalyn 实现。
• make 3: 使用 Kalyn 实现编译自身。

Setup.hs

Setup.hs 是 Haskell 项目的设置文件，用于配置项目的构建过程。

3. 项目配置文件介绍

Kalyn 项目的主要配置文件包括 package.yaml 和 stack.yaml。

package.yaml

package.yaml 是 Stack 项目的配置文件，定义了项目的元数据、依赖关系等。

stack.yaml

stack.yaml 是 Stack 构建工具的配置文件，指定了项目的依赖库、编译选项等。

stack.yaml.lock

stack.yaml.lock 是 Stack 构建工具的锁定文件，确保依赖库的版本一致性。

通过以上配置文件，可以确保项目在不同环境下的一致性和可重复性。

kalyn ⚗️ Self-hosting compiler from a Haskell-like Lisp directly to x86-64, from scratch. 项目地址: https://gitcode.com/gh_mirrors/ka/kalyn