SideWaffle 项目使用教程

1. 项目目录结构及介绍

SideWaffle 是一个为 Visual Studio 提供的项目和项模板的集合。以下是项目的目录结构及其简要介绍：

.
├── .gitattributes
├── .gitignore
├── README.md             # 项目说明文件
├── LICENSE.md            # 项目许可证文件
├── LigerShark.Templates  # 模板相关代码和资源
├── Project Templates     # 项目模板文件夹
├── SideWaffle.Common     # 公共库代码
├── TemplatePack          # 模板打包和构建相关脚本
├── item-templates/       # 项模板文件夹
├── assemblies            # 程序集文件夹，包含项目引用的库
├── add-telemtrywizard.ps1 # 添加遥测向导的 PowerShell 脚本
├── add-templateid.ps1    # 添加模板 ID 的 PowerShell 脚本
├── add-templatetypeparameter.ps1 # 添加模板类型参数的 PowerShell 脚本
├── appveyor.ps1          # Appveyor 持续集成相关的 PowerShell 脚本
├── appveyor.yml          # Appveyor 配置文件
├── build-main.ps1        # 主构建脚本
├── build-templates.proj  # 模板构建项目文件
├── multi-project-templates.docx # 多项目模板文档
├── release-notes.xml     # 版本更新说明文件
└── screenshot.png        # 项目截图

2. 项目的启动文件介绍

在 SideWaffle 项目中，并没有一个明确的“启动文件”，因为这是一个为 Visual Studio 提供模板的项目。用户通常不会直接运行项目中的任何文件，而是通过 Visual Studio 的“添加新项”或“添加新项目”对话框来使用这些模板。

如果需要运行项目中的脚本或者构建模板，通常会使用以下文件：

• build-main.ps1：这是主构建脚本，用于构建项目模板。
• appveyor.yml：这是配置文件，用于 Appveyor 持续集成服务。

3. 项目的配置文件介绍

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

• .gitignore：Git 忽略文件，用于指定在执行 git status、git add 或 git commit 时应该忽略的文件和目录。
• appveyor.yml：Appveyor 配置文件，用于定义持续集成和部署的流程。这个文件指定了构建环境、构建步骤、测试运行以及其他自动化任务。

这些配置文件对于项目的版本控制和自动化构建过程至关重要。在修改这些文件时，需要谨慎以确保项目的顺利构建和部署。