Skip to content

Commit 5163174

Browse files
committed
update readme
1 parent 44ed8d2 commit 5163174

File tree

2 files changed

+81
-53
lines changed

2 files changed

+81
-53
lines changed

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,71 @@
1-
# ncm -> flac converter
1+
# NCM格式转换工具
22

33
[English](./README_EN.md) | [中文](./README.md)
44

55
## 概述
66

7-
将.ncm格式音频文件转换为flac格式,提供windows客户端和WEB两种使用方式
7+
这是一个将网易云音乐的.ncm格式音频文件转换为flac格式的工具,提供Windows客户端和Web两种使用方式
88

9-
## 使用
9+
## 使用方法
1010

11-
### 客户端使用:
12-
[releases](https://github.com/lissettecarlr/ncmdump/releases)中下载后直接运行,目前只编译了windows版本,其他平台可以直接运行代码
11+
### 客户端使用
1312

14-
界面效果:
15-
![s1](./file/s1.gif)
13+
[releases](https://github.com/lissettecarlr/ncmdump/releases)页面下载最新版本后直接运行,目前只编译了Windows版本,其他平台可以直接运行源代码。
1614

17-
* 通过拖拽将文件放入界面
18-
* 通过双击界面弹出文件选择框进行选取
15+
操作演示:
16+
![客户端演示](./file/s1.gif)
1917

20-
----------------------
18+
支持两种导入方式:
19+
* 拖拽文件到界面中
20+
* 双击界面打开文件选择对话框
2121

22-
### 网页使用
23-
目前部署在Streamlit中:[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://ncmdump.streamlit.app/)
22+
### Web使用
2423

24+
访问Streamlit部署版本:[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://ncmdump.streamlit.app/)
2525

26-
界面效果:
27-
![s2](./file/s2.gif)
26+
操作演示:
27+
![Web演示](./file/s2.gif)
2828

29+
## 环境配置
2930

31+
如果需要从源代码运行,需要安装以下依赖:
3032

31-
## 环境
32-
如果要运行代码,则需要安装对应的库
33+
### 基础环境
3334

34-
基础环境:
3535
```bash
3636
pip install mutagen
3737
pip install pycryptodome
3838
```
3939

40-
GUI环境:
40+
### GUI环境
41+
4142
```bash
4243
pip install PyQt6
4344
pip install pyinstaller
4445
```
4546

46-
WEB环境:
47+
### Web环境
48+
4749
```bash
4850
pip install streamlit
4951
```
5052

51-
Docker环境:
53+
### Docker环境
54+
5255
```bash
5356
docker build -t ncmdump .
54-
docker run -d -p 23231:23231 ncmdump .
57+
docker run -d -p 23231:23231 ncmdump
5558
```
5659

57-
如果你比较懒,可以直接全安装:
60+
如果想一次安装所有依赖:
61+
5862
```bash
5963
pip install -r requirements.txt
6064
```
6165

62-
## 运行
66+
## 运行方法
6367

64-
### GUI
68+
### GUI程序
6569

6670
需要先安装基础环境和GUI环境
6771

@@ -70,20 +74,24 @@ pip install -r requirements.txt
7074
python gui.py
7175
```
7276

73-
or
74-
75-
编译成可执行文件:
77+
或者编译成可执行文件:
7678
```bash
7779
pyinstaller --onefile --add-data="file:file" -wF -i file/favicon-32x32.png -n "NCM_Tool" .\gui.py
7880
```
7981

80-
### WEB
81-
需要先安装基础环境和WEB环境
82+
### Web应用
83+
84+
需要先安装基础环境和Web环境
85+
8286
运行:
8387
```bash
8488
streamlit run web.py --server.port 1111 --server.maxUploadSize=500
8589
```
8690

91+
参数说明:
92+
- `--server.port 1111`:设置服务端口为1111
93+
- `--server.maxUploadSize=500`:设置最大上传文件大小为500MB
94+
8795

8896

8997

README_EN.md

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,71 @@
1-
# ncm -> flac Converter
1+
# NCM Format Converter
2+
23
[English](./README_EN.md) | [中文](./README.md)
34

45
## Overview
56

6-
Convert .ncm format audio files to flac format, providing both a Windows client and a web usage option.
7+
A tool that converts NetEase Cloud Music's .ncm format audio files to flac format, offering both Windows client and Web usage options.
78

89
## Usage
910

10-
### Client Usage:
11-
Download and run from [releases](https://github.com/lissettecarlr/ncmdump/releases). Currently, only the Windows version is compiled; other platforms can run the code directly.
11+
### Client Usage
12+
13+
Download the latest version from [releases](https://github.com/lissettecarlr/ncmdump/releases) and run it directly. Currently, only the Windows version is compiled; other platforms can run the source code directly.
1214

13-
Interface preview:
14-
![s1](./file/s3.gif)
15+
Operation demonstration:
16+
![Client Demo](./file/s3.gif)
1517

16-
----------------------
18+
File import methods:
19+
* Drag and drop files into the interface
20+
* Double-click the interface to open the file selection dialog
1721

1822
### Web Usage
19-
Currently deployed on Streamlit: [![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://ncmdump.streamlit.app/)
2023

21-
Interface preview:
22-
![s2](./file/s2.gif)
24+
Visit the Streamlit deployed version: [![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://ncmdump.streamlit.app/)
25+
26+
Operation demonstration:
27+
![Web Demo](./file/s2.gif)
28+
29+
## Environment Setup
2330

24-
## Environment
25-
To run the code, you need to install the corresponding libraries.
31+
If you need to run from source code, you'll need to install the following dependencies:
32+
33+
### Basic Environment
2634

27-
Basic environment:
2835
```bash
2936
pip install mutagen
3037
pip install pycryptodome
3138
```
3239

33-
GUI environment:
40+
### GUI Environment
41+
3442
```bash
3543
pip install PyQt6
3644
pip install pyinstaller
3745
```
3846

39-
Web environment:
47+
### Web Environment
48+
4049
```bash
4150
pip install streamlit
4251
```
4352

44-
If you're feeling lazy, you can install everything at once:
53+
### Docker Environment
54+
55+
```bash
56+
docker build -t ncmdump .
57+
docker run -d -p 23231:23231 ncmdump
58+
```
59+
60+
If you want to install all dependencies at once:
61+
4562
```bash
4663
pip install -r requirements.txt
4764
```
4865

49-
## Running
66+
## Running Instructions
5067

51-
### GUI
68+
### GUI Application
5269

5370
You need to install both the basic and GUI environments first.
5471

@@ -57,17 +74,20 @@ Run directly:
5774
python gui.py
5875
```
5976

60-
or
61-
62-
Compile into an executable:
77+
Or compile into an executable:
6378
```bash
6479
pyinstaller --onefile --add-data="file:file" -wF -i file/favicon-32x32.png -n "NCM Converter" .\gui.py
6580
```
6681

67-
### Web
82+
### Web Application
83+
6884
You need to install both the basic and web environments first.
6985

7086
Run:
7187
```bash
72-
streamlit run web.py --server.port 1111
73-
```
88+
streamlit run web.py --server.port 1111 --server.maxUploadSize=500
89+
```
90+
91+
Parameter description:
92+
- `--server.port 1111`: Set the server port to 1111
93+
- `--server.maxUploadSize=500`: Set the maximum upload file size to 500MB

0 commit comments

Comments
 (0)