Skip to content

Commit a629694

Browse files
committed
doc: update README
1 parent a310283 commit a629694

File tree

2 files changed

+21
-18
lines changed

2 files changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,45 @@
1-
A Javascript Drum Machine Made with React & tone.js
1+
# A Javascript Drum Machine Made with React & tone.js
22

3-
[Demo](https://hhow09.github.io/react-drum-machine/)
3+
Live Link: https://hhow09.github.io/react-drum-machine/
44

5-
install
5+
![Animation](./animation.gif)
66

7-
```bash
8-
yarn install
9-
```
10-
11-
dev
12-
13-
```bash
14-
yarn start
15-
```
7+
## Instruction
168

17-
### Instruction
18-
19-
#### Sound System
9+
### Sound System
2010

2111
- Click 'Play' or 'Spacebar' to start drum loop.
2212
- Click 'Stop' or 'Spacebar' to stop drum loop.
2313
- Click 'Reset' to clear drum patterns.
2414
- Click 'Random' to generate random patterns
2515

26-
#### DrumPad
16+
### DrumPad
2717

2818
- Click on 4x4 pads to create drum pattern.
2919
- Single-click for normal hit (velocity=0.8).
3020
- Double-click for accentuation (velocity=1).
3121
- Change Instrument on the right side menu.
3222

33-
#### Mixer
23+
### Mixer
3424

3525
- Adjust the volumn with mouse click on the height
3626
- volume unit: dB
3727
- Click 'Reset' on top-right to reset volumnes to 0 dB.
3828

39-
#### Reference
29+
## Development
30+
### install
31+
32+
```bash
33+
yarn install
34+
```
35+
36+
### dev
37+
38+
```bash
39+
yarn start
40+
```
41+
42+
## Reference
4043

4144
- [tone.js](https://tonejs.github.io/)
4245
- [colour palettes of vintage drum machines](https://github.com/hhow09/react-drum-machine/tree/master/src/assets/color%20ref)

animation.gif

1010 KB
Loading

0 commit comments

Comments
 (0)