speaker-calibration 1.0.7 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -5
- package/dist/main.js +1 -1
- package/dist/mlsGen.js +4 -4
- package/dist/mlsGen.wasm +0 -0
- package/package.json +15 -10
package/README.md
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
# Speaker-Calibration
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://app.netlify.com/sites/focused-hodgkin-0a6531/deploys)
|
|
4
|
+
|
|
5
|
+
# Contribution Guidelines
|
|
6
|
+
|
|
7
|
+
_As of 03/01/2022_
|
|
4
8
|
|
|
5
9
|
## Initial Setup
|
|
6
10
|
|
|
@@ -11,18 +15,30 @@ _As of 04/06/2022_
|
|
|
11
15
|
## Local Development
|
|
12
16
|
|
|
13
17
|
All outputs from the scripts/recipies below should be automatically placed in the `/dist` directory.
|
|
18
|
+
This is what will be served once the library is published.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
In `/dist/example` you will find a small example app that uses the `speaker-calibration` library.
|
|
14
23
|
|
|
15
24
|
### Javascript
|
|
25
|
+
|
|
16
26
|
In `package.json` you will see some key scripts:
|
|
17
27
|
|
|
18
|
-
1. `build:
|
|
28
|
+
1. `build:wasm` cleans and rebuilds the wasm files
|
|
19
29
|
2. `build:dev` tells webpack to build the `speaker-calibration` library in development watch mode,
|
|
20
30
|
outputing to `/dist`
|
|
21
|
-
3. `
|
|
31
|
+
3. `serve:dev` spins up an `express.js` server on port `3000` using `nodemon`. It serves the
|
|
32
|
+
`/dist` & `/dist/example` folders.
|
|
22
33
|
4. `lint` runs `eslint` on all js files in the project
|
|
23
34
|
5. `lint:fix` lints and automatically fixes all js files in the project.
|
|
24
35
|
6. `build:doc` builds the documentation using `jsdoc`. Outputs to `/doc`
|
|
25
|
-
|
|
36
|
+
|
|
37
|
+
Run `(1)` & `(2)` in seperate shell windows, with this setup you will be able to modify both the
|
|
38
|
+
library and front end examples with hot reload built in. `(3)` provides a simple abstraction on the
|
|
39
|
+
`makefile` recipies below. Run `(5)` precommit to keep you code standardized.
|
|
40
|
+
|
|
41
|
+
TODO Make `(5)` a precommit hook
|
|
26
42
|
|
|
27
43
|
### CPP/WASM
|
|
28
44
|
|
|
@@ -41,7 +57,7 @@ requires the installation of the Emscriten compiler. Instructions can be found o
|
|
|
41
57
|
|
|
42
58
|
We use [jsdoc](https://jsdoc.app/) standards to document our library.
|
|
43
59
|
|
|
44
|
-
###
|
|
60
|
+
### Listing
|
|
45
61
|
|
|
46
62
|
We use [ESLint](https://eslint.org/) to lint our code and enforce best practices. We are currently
|
|
47
63
|
using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
|
|
@@ -49,3 +65,8 @@ using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
|
|
|
49
65
|
### Styling
|
|
50
66
|
|
|
51
67
|
We use [Prettier](https://prettier.io/) to format our code.
|
|
68
|
+
|
|
69
|
+
## Deployment
|
|
70
|
+
|
|
71
|
+
Changes publshed to `main` will automatically trigger a deploy on the `netlify` project TODO: Fix
|
|
72
|
+
netlify deploy not serving the /dist & /example folders
|