Skip to content

Commit

Permalink
Rework the ReadMe to be more quick-start friendly (#1173) (#1221)
Browse files Browse the repository at this point in the history
* Rework the ReadMe to be more quick-start friendly (#1173)

* Start remodeling the ReadMe

* Fix typo, add italics to OS names

* add todo

* Finish up the body

* Update ToC

* Move stuff, fix typos

* Improve title

* Add a line

* Add link for cmake options

* Fix ToC

* Pi->Linux

* Add a comma

* Address feedback

* Add more Windows instructions

* Restructure Debugging section, add more links

* Add some periods

* Add link to Java SDK

* Add link to Producer C SDK in Key Features section

* Convert cmake options list to table

* Add kvssink parameters table, modify credential-path description, cleanup cmake table

* Add stream from file kvssink sample instructions

* Add instructions for how/where to view the footage from the samples in the Quick Start section

* Address comments

* Spelling and grammar

* Remove accidental link

* Downgrade Mac CI GCC version 13->12

* Add AWS Authentication to quickstart section

* megabytes -> mebibytes

* Address comments

* Fix paths

* Format element names

* Remove code formatting from links

* Format fixing

* Update README.md

* Update README.md

* Address comments

* Address comments

* Add link to AWS KVS Raspberry Pi doc
  • Loading branch information
stefankiesz authored Jan 10, 2025
1 parent 4257d74 commit e09903d
Showing 1 changed file with 250 additions and 134 deletions.
Loading

0 comments on commit e09903d

Please sign in to comment.