Logary项目启动与配置教程

1. 项目目录结构及介绍

Logary项目的目录结构如下：

logary/
├── .github/
│   └── workflows/
│       └── enable_testing.yml
├── .paket/
│   └── paket.dependencies
├── .vscode/
│   └── settings.json
├── appveyor.yml
├── build.fsx
├── contrib/
│   └── ...
├── dockerignore
├── doc/
│   └── ...
├── examples/
│   └── ...
├── fake.cmd
├── fake.sh
├── global.json
├── licenses/
│   └── ...
├── Makefile
├── NuGet.props
├── paket.lock
├── README.md
├── RELEASE_NOTES.md
├── skaffold.yaml
├── src/
│   └── ...
└── tools/
    └── ...

• .github/workflows/：存放GitHub Actions的工作流配置文件。
• .paket/：包含Paket依赖管理文件，用于管理项目依赖。
• .vscode/：Visual Studio Code的配置文件。
• appveyor.yml：用于配置AppVeyor持续集成服务。
• build.fsx：FAKE - Fake Build Script的F#脚本，用于构建项目。
• contrib/：可能包含社区贡献的代码或文档。
• dockerignore：Docker构建时需要忽略的文件和目录。
• doc/：项目文档目录。
• examples/：示例代码目录。
• fake.cmd和fake.sh：FAKE的命令行工具，用于构建项目。
• global.json：全局配置文件，可能包含项目设置。
• licenses/：存放项目使用的各种开源许可证文件。
• Makefile：Makefile构建脚本。
• NuGet.props：NuGet包的属性文件。
• paket.lock：Paket的锁定文件，确保构建时使用相同的依赖版本。
• README.md：项目说明文件。
• RELEASE_NOTES.md：版本发布说明。
• skaffold.yaml：Skaffold配置文件，用于容器化部署。
• src/：源代码目录。
• tools/：可能包含项目的工具和脚本。

2. 项目的启动文件介绍

项目的启动文件通常是build.fsx，这是一个FAKE - Fake Build Script的F#脚本，用于自动化构建、测试和打包等任务。例如，以下是一个简化的启动脚本示例：

#r "paket:\netstandard2.0\paket.coreclr.dll"
#load "paket/paket.fsx"

// 定义构建任务
Target.create "Build" (fun _ ->
    // 执行构建逻辑
)

// 定义默认任务
Target.create "Default" ignore

// 依赖关系
"Build" ==> "Default"

// 运行默认任务
Target.runOrDefault "Default"

这段脚本定义了构建任务和默认任务，并指定了任务之间的依赖关系。

3. 项目的配置文件介绍

项目的配置文件可能包括.paket/paket.dependencies、build.fsx和appveyor.yml等。

• paket.dependencies：这是Paket依赖管理文件，用于声明项目依赖。例如：

source https://api.nuget.org/v3-flatcontainer/

nuget Logary
nuget Logary.CSharp

• build.fsx：在FAKE脚本中，你可以设置构建参数和任务。例如：

// 设置构建参数
let configuration = "Release"

// 定义构建任务
Target.create "Build" (fun _ ->
    // 使用MSBuild构建项目
    MSBuild.build (fun p -> { p with Configuration = configuration }) "src/Logary.sln"
)

• appveyor.yml：用于配置AppVeyor持续集成服务。例如：

version: 1.0.{build}
assembly_info:
  patch: :build
build:
  project: src/Logary.sln
  configuration: Release

这个配置文件定义了如何使用AppVeyor自动化构建项目，并设置版本号。