amazon-kinesis-video-streams-producer-sdk-cpp
amazon-kinesis-video-streams-producer-sdk-cpp copied to clipboard
Rework the ReadMe to be more quick-start friendly
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
- Add a collapsible vertical table of contents
- Add a Quick Start section
- Extend samples instructions
- Add missing Windows instructions
- Fix incorrect dependency installation commands
- Add more links to resources and references
- New links include: AWS KVS getting started page, AWS KVS FAQs page, GStreamer element docs, Java Producer SDK
- Also added a link to Producer C in the Key Features section incase user does not need JNI nor GStreamer features
- Make the CMake Arguments section into a table and fix typos in the descriptions
- Make the kvssink parameters into a table, fix missing links, add in aws-region parameter
- Mention and show how to stream from file with the kvssink sample
- To the Quick Start section, add instructions for how/where to view the footage from the samples and link troubleshoot guides
- ...more misc. changes
Future Improvements
- Consider splitting the QuickStart instructions for building the SDK into build-with-dependencies a build-using-system-dependencies and demonstrate how to install the system dependencies and the correct versions.
- Improve upon and add to the Debugging/Troubleshooting section - likely should add more links to AWS docs. Specify Java version for JNI. Also should probably add a link to Java SDK and instructions if any are missing on that repo's ReadMe.
- Add installation commands to all the prerequisite packages such as git and cmake. This will likely only fit well if the QuickStart section gets restructured into 3 separate sections for each OS.
- Add a "Running Tests" section to show how to build and run the tests. Include details such as AWS authentication and how resources are managed when tests are running and failing.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.