Skip to content

Commit b09e565

Browse files
committed
improve readme
1 parent af1c690 commit b09e565

File tree

2 files changed

+19
-21
lines changed

2 files changed

+19
-21
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ TODO: add screenshot here showing the "simple example" UI, explain that this is
1616

1717
😔 there is almost no documentation yet (there is some, see next section below), to learn how to use this library I recommend you check out the source code of the [simple player example](examples/simple-player) to get started
1818

19-
Want to help improve the documentation or contribute to this project by improving and fixing it, then first check out the [TODOs section](#todos-help-wanted-) below, maybe there is something in the list you want to help with. Any contribution, even things not listed on the TODO list are of course welcome. To get started check out the section ["contributing" section](#contributing) below.
19+
Want to help improve the documentation or contribute to this project by improving and fixing it, then first check out the [TODOs section](#todos-help--prs-appreciated) below, maybe there is something in the list you want to help with. Any contribution, even things not listed on the TODO list are of course welcome. To get started check out the section ["contributing" section](#contributing-prs-welcome) below.
2020

2121
## installation
2222

@@ -178,7 +178,9 @@ the current [dom.d.ts on github](https://github.com/microsoft/TypeScript/blob/ma
178178

179179
* 4.0.0 removed UMD support, this and future versions will be ESM only
180180

181-
## TODOs (help / PRs appreciated 😊, see the ["contributing"](#contributing-prs-welcome) section above)
181+
## TODOs (help / PRs appreciated)
182+
183+
If you are interested in helping out 😊 by working on one of the following TODOs, please start by reading the ["contributing"](#contributing-prs-welcome) chapter above
182184

183185
* create a react example
184186
* create a vue.js example

examples/simple-player/README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,36 @@
22

33
## build
44

5-
first, use your favorite command line tool and go into the root of this project:
5+
### tools
66

7-
```shell
8-
cd /web-audio-api-player
9-
```
10-
11-
then use the follwing command in the root of this repository to build the "web-audio-api-player" itself:
7+
install the latest nodejs (if you haven't already) [nodejs](https://nodejs.org)
128

13-
`npm run build`
9+
update npm to latest version
1410

15-
Note: for more instructions about the web-audio-api-player itself check out the [web-audio-api-player README](../../README.md)
11+
`npm install npm@latest -g`
1612

17-
then, build the example (server & client) itself:
13+
### build the player
1814

19-
go into the example folder:
15+
first, use the VSCode terminal (or your favorite command line tool) and go into the root of this project:
2016

2117
```shell
22-
cd /web-audio-api-player/examples/simple-player
18+
cd /YOUR_REPOSITORIES_PATH/web-audio-api-player
2319
```
2420

25-
install the latest nodejs (if you haven't already) [nodejs](https://nodejs.org)
21+
then use the follwing command (in the root of this repository) to build the "web-audio-api-player" itself:
2622

27-
update npm to latest version
23+
`npm run build`
2824

29-
`npm install npm@latest -g`
25+
Note: for more instructions about the web-audio-api-player itself check out the [web-audio-api-player README](../../README.md)
3026

31-
install the server dependencies
27+
then, build the example (server & client) itself...
3228

33-
### client
29+
### example client
3430

3531
#### go into the client folder
3632

3733
```shell
38-
cd client
34+
cd /examples/simple-player/client
3935
```
4036

4137
#### install the client dependencies
@@ -50,12 +46,12 @@ npm i
5046
npm run build
5147
```
5248

53-
### server
49+
### example server
5450

5551
#### go into the server folder
5652

5753
```shell
58-
cd server
54+
cd /examples/simple-player/server
5955
```
6056

6157
#### install the server dependencies

0 commit comments

Comments
 (0)