Wiish项目使用教程

1. 项目目录结构及介绍

Wiish项目的目录结构如下：

wiish/
├── .github/              # GitHub相关配置文件
├── docs/                 # 项目文档
├── examples/             # 示例项目
├── img/                  # 项目图片资源
├── research/             # 研究资料
├── tests/                # 测试文件
├── wiish/                # Wiish核心代码库
├── .gitignore            # Git忽略文件
├── CHANGELOG.md          # 更改日志
├── CONTRIBUTING.md       # 贡献指南
├── DEV.md                # 开发文档
├── LICENSE.md            # 许可证文件
├── README.md             # 项目介绍
├── TODO                  # 待办事项
├── builddocs.sh          # 构建文档的脚本
├── config.nims           # Nim配置文件
├── logo.png              # 项目Logo
├── nakefile.nim          # 构建脚本
├── nim.cfg               # Nim配置文件
├── wiish.nimble          # Nim包配置文件
└── wiishcli.nim          # Wiish命令行工具

• .github/: 存放GitHub相关配置文件，例如工作流程（workflows）等。
• docs/: 存放项目文档，包括开发文档和使用指南。
• examples/: 包含一些使用Wiish框架的示例项目。
• img/: 存放项目的图片资源，如截图或Logo。
• research/: 存放与项目开发相关的研究资料。
• tests/: 包含项目的单元测试和集成测试。
• wiish/: Wiish框架的核心代码库，包含所有必要的Nim模块。

2. 项目的启动文件介绍

项目的启动文件是wiishcli.nim，这是Wiish项目的命令行接口。使用此文件，您可以执行如下的基本操作：

• 初始化项目：wiish init
• 运行项目：wiish run
• 构建项目：wiish build

例如，初始化一个新项目，您需要运行：

wiish init somedir

这将在somedir目录中创建一个新的Wiish项目。

3. 项目的配置文件介绍

Wiish项目的配置文件主要包括以下两个：

• config.nims: Nim项目的配置文件，它定义了Nim编译器的各种设置，例如编译器标志、路径等。
• wiish.nimble: Nim包的配置文件，它定义了Wiish包的元数据，如名称、版本、依赖等。

这些文件在项目开发过程中非常重要，它们确保了Wiish框架及其依赖能够正确地被编译和使用。开发者应该根据项目的具体需求来调整这些配置文件。