Revise README for clarity and feature updates

Updated the README to clarify the purpose of the MIDI editor and improved descriptions of features.
This commit is contained in:
Arain233
2026-02-07 11:33:01 +08:00
committed by GitHub
parent b0127a8ed7
commit 73dc3c0952
+5 -7
View File
@@ -2,7 +2,7 @@
[English](README.md) | [简体中文](README_CN.md) [English](README.md) | [简体中文](README_CN.md)
A full-featured web MIDI editor for singing voice production, similar to ACE-Studio and VOCALOID. It supports real-time drag editing of MIDI notes, lyric editing, audio waveform alignment, and importing/exporting MIDI files with lyrics. A full-featured web MIDI editor for singing voice preprocess. It supports real-time drag editing of MIDI notes, lyric editing, audio waveform alignment, and importing/exporting MIDI files with lyrics.
![MIDI Editor](https://img.shields.io/badge/React-19.2-blue) ![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue) ![Vite](https://img.shields.io/badge/Vite-7.2-purple) ![MIDI Editor](https://img.shields.io/badge/React-19.2-blue) ![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue) ![Vite](https://img.shields.io/badge/Vite-7.2-purple)
@@ -15,6 +15,7 @@ A full-featured web MIDI editor for singing voice production, similar to ACE-Stu
- Move notes: drag note blocks to adjust position and pitch - Move notes: drag note blocks to adjust position and pitch
- Resize start: drag the left edge to adjust start time - Resize start: drag the left edge to adjust start time
- Resize end: drag the right edge to adjust end time - Resize end: drag the right edge to adjust end time
- **Quick pitch adjust**: Command/Ctrl + Up/Down to nudge selected notes
- **Double-click to add**: Add new notes quickly in empty areas - **Double-click to add**: Add new notes quickly in empty areas
- **Piano key preview**: Click a key to audition the pitch - **Piano key preview**: Click a key to audition the pitch
@@ -37,7 +38,7 @@ A full-featured web MIDI editor for singing voice production, similar to ACE-Stu
- **Waveform display**: sync waveform with the MIDI timeline - **Waveform display**: sync waveform with the MIDI timeline
- **Formats**: MP3, WAV, OGG, FLAC, M4A, AAC - **Formats**: MP3, WAV, OGG, FLAC, M4A, AAC
- **Sync playback**: play audio and MIDI together with independent mute - **Sync playback**: play audio and MIDI together with independent volume control
- **Click to seek**: click waveform or timeline to seek - **Click to seek**: click waveform or timeline to seek
### ⚠️ Overlap Detection ### ⚠️ Overlap Detection
@@ -70,10 +71,6 @@ A full-featured web MIDI editor for singing voice production, similar to ACE-Stu
### Install ### Install
```bash ```bash
# Clone
git clone <repository-url>
cd MIDI_Editor
# Install dependencies # Install dependencies
npm install npm install
@@ -127,6 +124,7 @@ npm run preview
| ▶ / ⏸ | Play / Pause | | ▶ / ⏸ | Play / Pause |
| 2s ⏩ | Forward 2 seconds | | 2s ⏩ | Forward 2 seconds |
| ⏭ | Go to end | | ⏭ | Go to end |
| Selection | Play selected region |
## 🛠 Tech Stack ## 🛠 Tech Stack
@@ -170,4 +168,4 @@ npm run preview
│ └── midi.ts │ └── midi.ts
└── store/ └── store/
└── useMidiStore.ts └── useMidiStore.ts
``` ```