Skip to content

Commit 3cfad44

Browse files
committed
Update contribution
1 parent 4a77a3b commit 3cfad44

File tree

3 files changed

+87
-0
lines changed

3 files changed

+87
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
11
# @ffmpeg/core
2+
3+
To build @ffmpeg/core, make sure your docker is version 23.0+ as
4+
[buildx](https://docs.docker.com/build/architecture/) is adopted. Also
5+
You will need to install `make` to run build scripts.
6+
7+
## Build
8+
9+
Dev Build (single thread):
10+
```bash
11+
$ make dev
12+
```
13+
14+
Dev Build (multithread):
15+
```bash
16+
$ make dev-mt
17+
```
18+
19+
Prodution Build (single thread):
20+
```bash
21+
$ make prd
22+
```
23+
24+
Prodution Build (multithread):
25+
```bash
26+
$ make prd-mt
27+
```
28+
29+
> Each build might take around 1 hour depends on the spec of your machine,
30+
> subsequent builds are faster as most layers are cached.
31+
32+
The output file locates at **/packages/core** or **/packages/core-mt**.
33+
34+
## Publish
35+
36+
Simply run `npm publish` under **packages/core** or **/packages/core-mt**.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
11
# @ffmpeg/ffmpeg
2+
3+
The source code of @ffmpeg/ffmpeg locates at **/packages/ffmpeg**.
4+
5+
## Development
6+
7+
```bash
8+
$ npm run dev
9+
```
10+
11+
## Build
12+
13+
Transpile Typescript to JavaScript.
14+
15+
```bash
16+
$ npm run build
17+
```
18+
19+
## Lint
20+
21+
```bash
22+
$ npm run lint
23+
```
24+
25+
## Publish
26+
27+
Simply run `npm publish` under **packages/ffmpeg**.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
11
# @ffmpeg/util
2+
3+
The source code of @ffmpeg/util locates at **/packages/util**.
4+
5+
## Development
6+
7+
```bash
8+
$ npm run dev
9+
```
10+
11+
## Build
12+
13+
Transpile Typescript to JavaScript.
14+
15+
```bash
16+
$ npm run build
17+
```
18+
19+
## Lint
20+
21+
```bash
22+
$ npm run lint
23+
```
24+
25+
## Publish
26+
27+
Simply run `npm publish` under **packages/util**.

0 commit comments

Comments
 (0)