NiGui开源项目教程

1. 项目目录结构及介绍

NiGui项目是一个使用Nim语言编写的跨平台桌面GUI工具包。以下是项目的目录结构及其简要介绍：

NiGui/
├── .github/             # GitHub工作流和配置文件
│   └── workflows/
├── examples/            # 示例程序
├── src/                 # 源代码目录
│   └── nigui.nimble      # Nimble包配置文件
├── faq.md               # 常见问题解答
├── license.md           # 许可证信息
├── nimcache/            # Nim编译缓存目录（生成）
├── readme.md            # 项目README文件
└── screenshots.png      # 项目屏幕截图

• .github/: 包含GitHub Actions的工作流和配置文件，用于自动化项目的某些任务。
• examples/: 包含使用NiGui编写的示例程序，可以用来学习和参考。
• src/: 源代码目录，包含NiGui的所有Nim源文件。
• nigui.nimble: Nimble包的配置文件，用于管理NiGui的依赖和构建过程。
• faq.md: 常见问题解答文件，提供用户在使用过程中可能遇到的问题和解决方案。
• license.md: 包含NiGui使用的MIT许可证信息。
• nimcache/: Nim编译时生成的缓存目录，通常不需要手动操作。
• readme.md: 项目说明文件，介绍了NiGui的基本信息和如何使用。
• screenshots.png: 展示NiGui界面功能的屏幕截图。

2. 项目的启动文件介绍

在examples/目录下，你可以找到多个示例程序，这些程序可以作为启动项目的基础。例如，nimcalc.nim文件是一个简单的计算器示例。以下是启动文件的基本结构：

import nigui

proc main() =
  # 创建应用程序和窗口
  app.init()
  let window = newWindow("NiCalc")

  # 添加按钮、文本框等控件
  let textBox = newTextBox()
  let button = newButton("Calculate")
  window.add textBox
  window.add button

  # 设置事件处理
  button.on("click") do ():
    # 处理点击事件
    echo "Calculate button clicked!"

  # 显示窗口并运行应用程序
  app.run()

main()

这个启动文件展示了如何初始化应用程序，创建窗口，添加控件，设置事件处理程序，以及启动事件循环。

3. 项目的配置文件介绍

项目的配置文件是nigui.nimble，它位于src/目录下。这个文件用来定义NiGui包的元数据，以及它的依赖关系。以下是配置文件的基本内容：

# nimble包配置文件
package:
  name: "nigui"
  version: "0.2.8"
  authors:
    - "Simon Krauter"

requires:
  - nim >= 1.4.0

# 依赖项
# 这里可以添加NiGui依赖的其他包

# 代码清理规则
clean:
  - nimcache

在这个文件中，我们定义了包的名称、版本和作者，指定了Nim的版本要求，以及一些清理规则。如果你需要添加其他依赖项，你可以在requires部分声明它们。