Skip to content

Commit

Permalink
ReadMe Fixes (#2083)
Browse files Browse the repository at this point in the history
* Add copy code buttons to github clone commands (#1928)

* Add copy code buttons to github clone commands

* Add language specifier

* build -> built (#1925)

* Update clone command
  • Loading branch information
stefankiesz authored Nov 22, 2024
1 parent 2815eac commit 245e74d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,21 @@ Please refer to the release notes in [Releases](https://github.com/awslabs/amazo
### Download
To download run the following command:

`git clone --recursive https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-c.git`
```shell
git clone https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-c.git --single-branch -b main kvs-webrtc-sdk
```

You will also need to install `pkg-config` and `CMake` and a build environment

### Configuring on Ubuntu / Unix

Create a build directory in the newly checked out repository, and execute CMake from it.

`mkdir -p amazon-kinesis-video-streams-webrtc-sdk-c/build; cd amazon-kinesis-video-streams-webrtc-sdk-c/build; cmake .. `
```shell
mkdir -p amazon-kinesis-video-streams-webrtc-sdk-c/build; cd amazon-kinesis-video-streams-webrtc-sdk-c/build; cmake ..
```

We have provided an example of using GStreamer to capture/encode video, and then send via this library. This is only build if `pkg-config` finds
We have provided an example of using GStreamer to capture/encode video, and then send via this library. This is only built if `pkg-config` finds
GStreamer is installed on your system.

On Ubuntu and Raspberry Pi OS you can get the libraries by running
Expand Down

0 comments on commit 245e74d

Please sign in to comment.