LyricsX 项目安装与使用教程

1. 项目的目录结构及介绍

LyricsX 是一款适用于 macOS 的终极歌词应用。以下是项目的目录结构及其简要介绍：

LyricsX/
├── .github/             # GitHub 相关配置文件
├── .gitignore           # 指定 Git 忽略的文件和目录
├── .swiftlint.yml       # SwiftLint 配置文件，用于 Swift 代码风格检查
├── LyricsX.xcodeproj    # Xcode 项目文件
├── LyricsX/             # LyricsX 应用程序的源代码
├── LyricsXHelper/       # 辅助工具的源代码
├── docs/                # 文档目录
├── img/                 # 图片资源目录
├── crowdin.yml          # Crowdin 配置文件，用于多语言支持
├── ExportOptions.plist  # Xcode 构建配置文件
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件
└── appcast.xml          # Sparkle 更新配置文件

2. 项目的启动文件介绍

项目的启动主要通过 Xcode 打开 LyricsX.xcodeproj 文件。这个文件是 Xcode 项目的主要配置文件，它包含了项目中的所有源代码文件和资源文件，并且定义了构建目标。

在 Xcode 中，你可以直接运行项目来启动 LyricsX 应用程序。启动文件主要包括以下部分：

• AppDelegate.swift: 应用程序的委托类，负责处理应用程序的生命周期事件。
• ViewController.swift: 主视图控制器，管理应用程序的用户界面。

3. 项目的配置文件介绍

以下是项目中的几个主要配置文件及其作用：

• .gitignore: 指定 Git 应该忽略的文件和目录，例如编译产生的中间文件、日志文件等。

• .swiftlint.yml: SwiftLint 的配置文件，用于定义代码风格规则。通过配置这个文件，可以保证代码的一致性和规范性。

• crowdin.yml: Crowdin 的配置文件，用于设置项目国际化时的翻译流程和配置。

• ExportOptions.plist: Xcode 构建配置文件，用于定义打包和发布应用程序时的设置。

• appcast.xml: Sparkle 的更新配置文件，用于配置应用程序的自动更新功能。

通过正确配置这些文件，可以确保项目在开发、构建和发布过程中按照预期运行。