Skip to content

Commit e7c4598

Browse files
authored
Update README.md
1 parent 6649d14 commit e7c4598

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,30 @@ ffmpeg-go is golang port of https://github.com/kkroening/ffmpeg-python
44

55
check examples/example_test.go and ffmpeg_test.go for more examples.
66

7+
# How to get and use
8+
You can get this package via:
9+
```
10+
go get -u github.com/u2takey/ffmpeg-go
11+
```
12+
13+
> **Note**: `ffmpeg-go` makes no attempt to download/install FFmpeg, as `ffmpeg-go` is merely a pure-Go wrapper - whereas FFmpeg installation is platform-dependent/environment-specific, and is thus the responsibility of the user, as described below.
14+
15+
### Installing FFmpeg
16+
17+
Before using `ffmpeg-go`, FFmpeg must be installed and accessible via the `$PATH` environment variable.
18+
19+
There are a variety of ways to install FFmpeg, such as the [official download links](https://ffmpeg.org/download.html), or using your package manager of choice (e.g. `sudo apt install ffmpeg` on Debian/Ubuntu, `brew install ffmpeg` on OS X, etc.).
20+
21+
Regardless of how FFmpeg is installed, you can check if your environment path is set correctly by running the `ffmpeg` command from the terminal, in which case the version information should appear, as in the following example (truncated for brevity):
22+
23+
```
24+
$ ffmpeg
25+
ffmpeg version 4.2.4-1ubuntu0.1 Copyright (c) 2000-2020 the FFmpeg developers
26+
built with gcc 9 (Ubuntu 9.3.0-10ubuntu2)
27+
```
28+
29+
> **Note**: The actual version information displayed here may vary from one system to another; but if a message such as `ffmpeg: command not found` appears instead of the version information, FFmpeg is not properly installed.
30+
731
# Examples
832

933
```go

0 commit comments

Comments
 (0)