ToBI Player 项目使用教程

ToBI Player 项目使用教程

tobiplayerA small tool for self, and it can display pitch contour upon waveform项目地址:https://gitcode.com/gh_mirrors/to/tobiplayer

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

ToBI Player 项目的目录结构如下：

tobiplayer/
├── scripts/
├── src/
├── .gitignore
├── LICENSE
├── README.md
├── ToBI-Player.gif
├── electron-builder.json
├── package-lock.json
├── package.json
├── vite.config.js

目录介绍

• scripts/: 包含项目的脚本文件。
• src/: 包含项目的主要源代码。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• ToBI-Player.gif: 项目的演示图片。
• electron-builder.json: Electron 构建配置文件。
• package-lock.json: 锁定项目依赖的版本。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• vite.config.js: Vite 构建工具的配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的 scripts 部分。以下是关键的启动脚本：

{
  "scripts": {
    "dev": "vite",
    "build:mac": "electron-builder --mac"
  }
}

启动脚本介绍

• npm run dev: 启动开发服务器，使用 Vite 进行开发。
• npm run build:mac: 构建 macOS 平台的应用程序包。

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的核心配置文件，包含项目的基本信息、依赖、脚本等。

{
  "name": "tobiplayer",
  "version": "1.0.0",
  "description": "A small tool for self and it can display pitch contour upon waveform",
  "main": "src/main.js",
  "scripts": {
    "dev": "vite",
    "build:mac": "electron-builder --mac"
  },
  "dependencies": {
    // 依赖列表
  },
  "devDependencies": {
    // 开发依赖列表
  }
}

electron-builder.json

electron-builder.json 是 Electron 构建工具的配置文件，用于配置应用程序的打包和分发。

{
  "appId": "com.example.tobiplayer",
  "productName": "ToBI Player",
  "directories": {
    "output": "build"
  },
  "mac": {
    "category": "public.app-category.utilities"
  }
}

vite.config.js

vite.config.js 是 Vite 构建工具的配置文件，用于配置开发服务器和构建过程。

import { defineConfig } from 'vite';

export default defineConfig({
  // 配置选项
});

以上是 ToBI Player 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

tobiplayerA small tool for self, and it can display pitch contour upon waveform项目地址:https://gitcode.com/gh_mirrors/to/tobiplayer