Skip to content

Commit 3117ee0

Browse files
authored
Application name was changed in README.md
1 parent b62b2fe commit 3117ee0

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,37 +28,37 @@ A command-line tool to generate sine wave audio buffers.
2828
```bash
2929
# Clone and build
3030
git clone <repository-url>
31-
cd sine_generator
31+
cd singen
3232
cargo build --release
3333

34-
# The binary will be at ./target/release/sine_generator
34+
# The binary will be at ./target/release/singen
3535
```
3636
### Basic Examples
3737

3838
```bash
3939
# Default settings (440Hz, 16kHz, stereo 16-bit, 1ms)
40-
./sine_generator
40+
./singen
4141

4242
# Generate 1kHz sine at 48kHz for 10ms, 24-bit
43-
./sine_generator -f 1000 -r 48000 -b 24 -d 10
43+
./singen -f 1000 -r 48000 -b 24 -d 10
4444

4545
# Mono output with C array format
46-
./sine_generator -c 1 -o carray
46+
./singen -c 1 -o carray
4747

4848
# Optimize for USB packets (64-byte boundaries)
49-
./sine_generator -r 32000 -d 1 -p
49+
./singen -r 32000 -d 1 -p
5050

5151
# Rust array for embedded use
52-
./sine_generator -r 16000 -d 1 -o rustarray
52+
./singen -r 16000 -d 1 -o rustarray
5353

5454
# Just show info without generating data
55-
./sine_generator -a
55+
./singen -a
5656

5757
# Raw binary output (pipe to file)
58-
./sine_generator -r 16000 -d 10 -o raw > sinewave.bin
58+
./singen -r 16000 -d 10 -o raw > sinewave.bin
5959

6060
# Wav output (pipe to file)
61-
./sine_generator -d 1000 -f 1000 -o wav > sinewave.wav
61+
./singen -d 1000 -f 1000 -o wav > sinewave.wav
6262

6363

6464
```
@@ -67,7 +67,7 @@ cargo build --release
6767

6868
```
6969
Sine Wave Generator for USB Audio Testing
70-
Usage: sine_generator [OPTIONS]
70+
Usage: singen [OPTIONS]
7171
7272
Options:
7373
-f, --frequency FREQ Sine wave frequency in Hz (default: 440.0)
@@ -87,9 +87,9 @@ Options:
8787
-h, --help Show this help message
8888
8989
Examples:
90-
sine_generator -f 1000 -r 48000 -b 16 -d 10 -o carray
91-
sine_generator --frequency 440 --rate 44100 --channels 1 --bits 24
92-
sine_generator -r 16000 -d 1 -o rustarray -p
90+
singen -f 1000 -r 48000 -b 16 -d 10 -o carray
91+
singen --frequency 440 --rate 44100 --channels 1 --bits 24
92+
singen -r 16000 -d 1 -o rustarray -p
9393
```
9494

9595
## Output Formats
@@ -170,7 +170,7 @@ The tool uses high-precision floating-point math to generate sine waves:
170170
1. Generate a C array:
171171

172172
```bash
173-
./sine_generator -r 16000 -d 1 -o carray > sine_buffer.h
173+
./singen -r 16000 -d 1 -o carray > sine_buffer.h
174174
```
175175

176176
2. Include in your project:
@@ -185,7 +185,7 @@ The tool uses high-precision floating-point math to generate sine waves:
185185
1. Generate a Rust array:
186186

187187
```bash
188-
./sine_generator -r 16000 -d 1 -o rustarray > src/sine_buffer.rs
188+
./singen -r 16000 -d 1 -o rustarray > src/sine_buffer.rs
189189
```
190190

191191
2. Include in your project:
@@ -200,7 +200,7 @@ The tool uses high-precision floating-point math to generate sine waves:
200200
```bash
201201
# Generate multiple test frequencies
202202
for freq in 440 1000 2000 4000; do
203-
./sine_generator -f $freq -r 48000 -d 100 -o raw > test_${freq}hz.bin
203+
./singen -f $freq -r 48000 -d 100 -o raw > test_${freq}hz.bin
204204
done
205205
```
206206

0 commit comments

Comments
 (0)