add: 自述文件

2024-03-10 19:27:01 +08:00 · 2024-03-10 19:27:01 +08:00 · 72b3fe54a8
commit 72b3fe54a8
parent ff0b183f4f
1 changed files with 21 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,21 @@
+# Canon
+
+简单的`Pascal`编译器。
+
+## 项目结构
+
+主要由以下三个项目组成：
+
+- `Canon.Core` 核心的编译器库，负责词法分析、语法分析、语义分析和目标代码生成等等一系列工作；
+- `Canon.Console`编译器的控制台应用程序，负责处理命令行参数和读写文件等等工作；
+- `Canon.Tests`对`Canon.Core`进行测试的测试库。
+
+## 开始使用
+
+需要：
+
+- `Dotnet SDK 8.0`
+- `Visual Studio 2022`或者`Rider 2023.3.3`
+
+才能运行和编辑该项目。
+