Skip to content
This repository was archived by the owner on Mar 22, 2022. It is now read-only.

Misc. README updates#18

Merged
jehumb-havok merged 12 commits intomasterfrom
feature/readme
Jul 22, 2019
Merged

Misc. README updates#18
jehumb-havok merged 12 commits intomasterfrom
feature/readme

Conversation

@jehumb-havok
Copy link
Copy Markdown
Member

@jehumb-havok jehumb-havok commented Jul 20, 2019

Simplify checkout instructions now that #16 is fixed.
Other minor rephrasing and clarifications.

Simplify the instructions to checkout the repository by using the
`--recursive` flag to `git clone` instead of suggesting to manually
update submodules in two steps.
Use direct GitHub links instead of manually-crafted ones when
referencing issues, even from other repositories, to enable
cross-repository notification messages.
@jehumb-havok jehumb-havok added the doc Documentation label Jul 20, 2019
@jehumb-havok jehumb-havok added this to the Initial public preview milestone Jul 20, 2019
@jehumb-havok jehumb-havok requested a review from a team July 20, 2019 17:08
@jehumb-havok jehumb-havok self-assigned this Jul 20, 2019
Avoid talking about "streaming" in the README, which may be confused
with one-way streaming like HTML5 video or other similar technologies.
Instead use the term "real-time communication" to underline the two-way
nature of the communications streams.
@jehumb-havok jehumb-havok requested a review from eanders-ms July 20, 2019 17:26
@jehumb-havok
Copy link
Copy Markdown
Member Author

@eanders-ms I checked and now that #16 is fixed one simply need to do a git clone --recursive to get a fresh new repository at the correct revision, past the change you were missing. No need for 2 separate steps with an explicit git submodule update. So updated the README.

Deprecate the `dev` branch, which is fully merged into `master`, to
avoid any confusion, and mention `master` as the development branch.

Briefly mention the `feature/m75` branch where upgrade to WebRTC M75
release just started.
This was not immediately obvious, as was referenced only from the WebRTC
UWP project's README. Now explicitly listing it as dependency.
Comment thread README.md Outdated
Comment thread README.md Outdated
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

doc Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants