diff --git a/README.md b/README.md index 356e7b33ce..3d23f3030e 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,9 @@ 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 @@ -65,9 +67,11 @@ You will also need to install `pkg-config` and `CMake` and a build environment 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