Skip to content

Commit

Permalink
Rework the ReadMe to be more quick-start friendly (#1173)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
stefankiesz authored Dec 26, 2024
1 parent 0b5c45b commit 12830f1
Show file tree
Hide file tree
Showing 2 changed files with 245 additions and 132 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ jobs:
id-token: write
contents: read
env:
CC: /usr/local/bin/gcc-13
CXX: /usr/local/bin/g++-13
CC: /usr/local/bin/gcc-12
CXX: /usr/local/bin/g++-12
AWS_KVS_LOG_LEVEL: 2
steps:
- name: Clone repository
Expand Down
Loading

0 comments on commit 12830f1

Please sign in to comment.