From bdc3455dd95c46674d3c01459d8a84fd866f8c8d Mon Sep 17 00:00:00 2001 From: luke Date: Sun, 8 Jun 2025 20:06:27 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 +++++++---- build/README.md | 31 +++++++++++++++++-- .../Snow's-Journey.md} | 0 3 files changed, 40 insertions(+), 9 deletions(-) rename doc/{Snow 心路历程/Snow 心路历程.md => Snow's-Journey/Snow's-Journey.md} (100%) diff --git a/README.md b/README.md index 5b40825..52d4e39 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Snow Icon + Snow Icon

Snow编程语言

@@ -36,7 +36,7 @@ Snow 语言是一个正在发展的编程语言,采用类模块（module）语 Snow 语言受到 LLM 驱动代码生成趋势的启发,强调简单而清晰的语法和严格的类型系统,以帮助人工智能模型更好地理解程序结构。语言使用显式的 `module` 声明来组织代码,用 `function`,`parameter`,`return_type`,`body` 等关键字分隔不同代码块,语法结构固定且易读。此外,Snow 实现了语义分析来检查变量作用域和类型一致性,在编译阶段捕获错误并确保生成的中间代码正确无误。这种自上而下的编译流程,使得代码设计和生成更加模块化,可解释,也有利于调试和优化。 -相关背景: [心路历程](doc/Snow%20心路历程/Snow%20心路历程.md) +相关背景: [心路历程](doc/Snow's-Journey/Snow's-Journey.md) ## 下载Snow发行版 @@ -70,7 +70,7 @@ Snow 语言受到 LLM 驱动代码生成趋势的启发,强调简单而清晰的 使用IDEA配置好的运行配置SnowCompiler - ![IMG_运行配置文件_1.png](doc/README/IMG/IMG_%E8%BF%90%E8%A1%8C%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6_1.png) + ![IMG_运行配置文件_1.png](doc/README/IMG/IMG_Run-Profile_1.png) 4. **运行成功** @@ -325,6 +325,12 @@ end module * `io/`：输入输出辅助类（加载指令,文件解析等） * 其他如 `factories/`,`utils/` 等目录包含指令创建和调试工具类 +## 相关文档 + +[Git 管理规范](doc/Git-Management/Git-Management.md) + + + ## 开发计划 / TODO * 扩展标准库支持和更多内置模块,如字符串,文件操作等常用功能。 @@ -333,6 +339,6 @@ end module * 增加更多示例程序试,丰富项目文档和用例。 ## 加入我们 -* 微信: xuxiaolankaka -* QQ: 1399528359 -* E-Mail: luke.k.xu@hotmail.com \ No newline at end of file +* 微信: `xuxiaolankaka` +* QQ: `1399528359` +* E-Mail: `luke.k.xu@hotmail.com` \ No newline at end of file diff --git a/build/README.md b/build/README.md index cd58efd..085aac2 100644 --- a/build/README.md +++ b/build/README.md @@ -1,6 +1,31 @@ -使用 build——project2tar.ps1 需要在管理员权限下的 PowerShell 输入下面的内容 +### 使用 `build-project2tar.ps1` 脚本 -``` +在执行 `build-project2tar.ps1` 脚本之前，您需要确保 PowerShell 的执行策略允许运行脚本。默认情况下，PowerShell 可能阻止未签名的脚本执行。因此，您需要设置适当的执行策略。 + +#### 步骤 1：以管理员身份打开 PowerShell + +* 在 Windows 系统中，搜索 **PowerShell**，右键点击 **Windows PowerShell**，并选择 **以管理员身份运行**。 + +#### 步骤 2：设置 PowerShell 执行策略 + +为了允许执行 PowerShell 脚本，您需要调整当前用户的执行策略。输入以下命令并按 Enter： + +```powershell Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned ``` -Tip:RemoteSigned 表示：本地创建的脚本可以运行，从互联网下载的脚本必须有签名。 \ No newline at end of file + +#### 解释： + +* `-Scope CurrentUser`：此参数指定该执行策略仅对当前用户有效，而不会影响系统范围内的其他用户。 +* `-ExecutionPolicy RemoteSigned`：此策略表示： + + * 本地创建的脚本可以直接运行。 + * 从互联网下载的脚本必须具备有效的数字签名才能运行。没有签名的脚本将无法执行，除非您先解除阻止该脚本。 + +#### 步骤 3：运行 `build-project2tar.ps1` 脚本 + +设置完成后，您可以在 PowerShell 中运行 `build-project2tar.ps1` 脚本。确保您已经切换到包含该脚本的目录，或提供完整的文件路径来执行它。 + +```powershell +.\build-project2tar.ps1 +``` \ No newline at end of file diff --git a/doc/Snow 心路历程/Snow 心路历程.md b/doc/Snow's-Journey/Snow's-Journey.md similarity index 100% rename from doc/Snow 心路历程/Snow 心路历程.md rename to doc/Snow's-Journey/Snow's-Journey.md