Abricotine 项目安装与使用教程

1. 项目目录结构及介绍

Abricotine 项目的目录结构如下：

abricotine/
├── app/
│   ├── default/
│   └── ...
├── docs/
├── icons/
├── github/workflows/
├── .gitignore
├── .jshintrc
├── .npmrc
├── .tern-project
├── LICENSE
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── package-lock.json
├── package.json
└── screenshot.jpg

目录结构介绍

• app/: 包含应用程序的主要代码文件。
  • default/: 默认配置和资源文件。
• docs/: 项目文档文件。
• icons/: 应用程序图标文件。
• github/workflows/: GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件配置。
• .jshintrc: JSHint 配置文件。
• .npmrc: npm 配置文件。
• .tern-project: Tern 配置文件。
• LICENSE: 项目许可证文件。
• PULL_REQUEST_TEMPLATE.md: Pull Request 模板文件。
• README.md: 项目介绍和使用说明文件。
• package-lock.json: npm 依赖锁定文件。
• package.json: 项目依赖和脚本配置文件。
• screenshot.jpg: 项目截图文件。

2. 项目启动文件介绍

Abricotine 项目的启动文件是 app/default/main.js。该文件负责初始化应用程序并启动主窗口。

主要功能

• 初始化 Electron 应用程序。
• 创建主窗口并加载应用程序界面。
• 处理应用程序的生命周期事件（如窗口关闭、应用程序退出等）。

3. 项目配置文件介绍

package.json

package.json 是 npm 项目的配置文件，包含项目的元数据和依赖信息。

{
  "name": "abricotine",
  "version": "1.1.4",
  "description": "Markdown editor with inline preview",
  "main": "app/default/main.js",
  "scripts": {
    "start": "electron .",
    "build": "electron-builder"
  },
  "dependencies": {
    "electron": "^13.1.7",
    "pandoc": "^2.14.2"
  },
  "devDependencies": {
    "electron-builder": "^22.11.7"
  }
}

主要配置项

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 应用程序的入口文件。
• scripts: 定义了项目的脚本命令，如 start 用于启动应用程序，build 用于构建应用程序。
• dependencies: 项目运行时依赖的包。
• devDependencies: 项目开发时依赖的包。

.gitignore

.gitignore 文件用于指定 Git 版本控制系统忽略的文件和目录。

# Node.js
node_modules/

# Build artifacts
dist/

# OS-specific files
.DS_Store
Thumbs.db

主要忽略项

• node_modules/: 忽略 Node.js 依赖包目录。
• dist/: 忽略构建输出目录。
• .DS_Store, Thumbs.db: 忽略操作系统生成的临时文件。

通过以上内容，您可以了解 Abricotine 项目的目录结构、启动文件和配置文件的基本信息。希望这份教程对您有所帮助！