awslabs / amazon-kinesis-video-streams-producer-sdk-cpp

Amazon Kinesis Video Streams Producer SDK for C++ is for developers to install and customize for their connected camera and other devices to securely stream video, audio, and time-encoded data to Kinesis Video Streams.
Apache License 2.0
376 stars 337 forks source link

Rework the ReadMe to be more quick-start friendly #1173

Open stefankiesz opened 4 months ago

stefankiesz commented 4 months ago

What was changed? The ReadMe was re-worked to be more quick-start friendly. Missing information was added and made into tables. Typos and grammar issues were addressed. (More details in the Overview section below.)

Why was it changed? To improve the ReadMe and correct outstanding issues.

How was it changed? By modifying the ReadMe document to address the above issues.

What testing was done for the changes? The document was pasted into a spelling and grammar checker.


Overview


Future Improvements



By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 0% with 105 lines in your changes missing coverage. Please review.

Project coverage is 16.30%. Comparing base (eeb392f) to head (03d8f84). Report is 10 commits behind head on develop.

:exclamation: Current head 03d8f84 differs from pull request most recent head 3bb045b

Please upload reports for the commit 3bb045b to get more accurate results.

Files Patch % Lines
samples/kvssink_gstreamer_sample.cpp 0.00% 50 Missing :warning:
...mazonaws/kinesis/video/producer/jni/Parameters.cpp 0.00% 46 Missing :warning:
src/gstreamer/gstkvssink.cpp 0.00% 8 Missing :warning:
...s/video/producer/jni/KinesisVideoClientWrapper.cpp 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1173 +/- ## =========================================== - Coverage 16.48% 16.30% -0.18% =========================================== Files 50 50 Lines 7019 7095 +76 =========================================== Hits 1157 1157 - Misses 5862 5938 +76 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.