Skip to content

Commit 5a6d8ff

Browse files
authored
chore: add chinese zh-cn readme (#180)
1 parent 6bb59e2 commit 5a6d8ff

File tree

2 files changed

+90
-3
lines changed

2 files changed

+90
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

22
# Rustortion
33

4+
English | [简体中文](README.zh-CN.md)
5+
46
A guitar amp simulator built in Rust using JACK.
57

68
## Screenshot
@@ -45,11 +47,15 @@ With the rust toolchain installed, you can clone the repository and run the appl
4547
```bash
4648
sudo apt-get install libjack-jackd2-dev libasound2-dev pkg-config
4749
cargo run --release
48-
// on some linux machines with pipewire you have to run jack explicitly
49-
// dont forget to install pipewire jack emulator: sudo apt-get install pipewire-jack
50-
pw-jack cargo run --release
5150
```
5251

52+
> [!TIP]
53+
> On some Linux machines with PipeWire, you may need to run JACK explicitly:
54+
> ```bash
55+
> sudo apt-get install pipewire-jack
56+
> pw-jack cargo run --release
57+
> ```
58+
5359
## Contributing
5460
5561
This is an experimental project. Feel free to open issues or submit pull requests.

README.zh-CN.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Rustortion
2+
3+
[English](README.md) | 简体中文
4+
5+
一款使用 Rust 和 JACK 构建的吉他音箱模拟器。
6+
7+
## 截图
8+
9+
![Rustortion](screenshots/rustortion.png)
10+
11+
## 功能特性
12+
13+
- 低延迟音频处理,支持可配置的过采样
14+
- 多级音箱模拟(前级放大、压缩器、音色堆栈、后级放大等)
15+
- 支持吉他和贝斯的脉冲响应箱体模拟
16+
- 预设的保存与加载
17+
- 实时录音功能
18+
- 内置调音器
19+
- 基础 MIDI 控制器支持
20+
- 使用 [Iced](https://github.com/iced-rs/iced) 构建的图形界面
21+
22+
## 系统要求
23+
24+
- **Linux** 系统,需启用 PipeWire(开启 JACK 支持)
25+
- **Rust** 工具链:[安装 Rust](https://rustup.rs/)
26+
27+
> [!NOTE]
28+
> 本项目已在 Raspberry Pi 4 和较高配置的台式电脑上测试通过。在其他硬件上的表现可能有所不同。
29+
30+
## 运行方式
31+
32+
### 预编译二进制文件
33+
34+
您可以从 [发布页面](https://github.com/OpenSauce/rustortion/releases/) 下载预编译的二进制压缩包。
35+
36+
```bash
37+
sudo apt-get install libjack-jackd2-0
38+
tar -xf rustortion-x86_64-unknown-linux-gnu.tar.xz
39+
cd rustortion-x86_64-unknown-linux-gnu
40+
./rustortion
41+
```
42+
43+
### 从源码运行/编译
44+
45+
安装好 Rust 工具链后,您可以克隆仓库并运行应用程序:
46+
47+
```bash
48+
sudo apt-get install libjack-jackd2-dev libasound2-dev pkg-config
49+
cargo run --release
50+
```
51+
52+
> [!TIP]
53+
> 在某些使用 PipeWire 的 Linux 机器上,您可能需要显式运行 JACK:
54+
> ```bash
55+
> sudo apt-get install pipewire-jack
56+
> pw-jack cargo run --release
57+
> ```
58+
59+
## 参与贡献
60+
61+
这是一个实验性项目。欢迎提交 issue 或 pull request。
62+
63+
## 许可证
64+
65+
本项目基于 **MIT License** 提供。
66+
67+
Rustortion 正在积极开发中,使用风险自负。
68+
69+
### 脉冲响应
70+
71+
#### Science Amplification
72+
73+
本项目包含经 [Science Amplification](https://www.scienceamps.com/) 授权使用的脉冲响应。
74+
75+
#### 其他
76+
77+
本项目还包含来自 [freesound.org](https://freesound.org/) 的自由授权脉冲响应:
78+
79+
- [Multiple Cabinets – Jesterdyne](https://freesound.org/people/jesterdyne/)
80+
- [Bristol Mix – Mansardian](https://freesound.org/people/mansardian/sounds/648392/)
81+
- [Brown Cab – Tosha73](https://freesound.org/people/tosha73/sounds/507167/)

0 commit comments

Comments
 (0)