Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Improved the main README of the SRT project #2357

Merged
merged 1 commit into from
Jun 10, 2022
Merged

[docs] Improved the main README of the SRT project #2357

merged 1 commit into from
Jun 10, 2022

Conversation

mbakholdina
Copy link
Collaborator

@mbakholdina mbakholdina commented Jun 3, 2022 •
edited
Loading

Improved the main README of the SRT project:

  • Refactored and updated README structure as discussed in [Docs] Improve README #1779.
  • Added the table with quick links in the "Getting Started" section as suggested by Steve.
  • Moved Build Instructions in separate documents under docs/build.
  • Added "Features", "Sample Applications and Tools", "Contributing", "License", "Release History" sections.

Fixes #1779.

@mbakholdina mbakholdina self-assigned this Jun 3, 2022
@mbakholdina mbakholdina added [docs] Area: Improvements or additions to documentation Type: Enhancement Indicates new feature requests labels Jun 3, 2022
@mbakholdina mbakholdina added this to the v1.5.0 milestone Jun 3, 2022
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
ethouris
ethouris reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 3, 2022
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some minor edits.

@mbakholdina mbakholdina force-pushed the mbakholdina/readme-improvements branch 4 times, most recently from 0f08638 to c4c820f Compare June 8, 2022 14:13
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
stevomatthews
stevomatthews reviewed Jun 8, 2022
View reviewed changes
Copy link
Collaborator

@stevomatthews stevomatthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edits

@mbakholdina mbakholdina force-pushed the mbakholdina/readme-improvements branch 2 times, most recently from 8acbca4 to 1c10c0f Compare June 8, 2022 16:08
maxsharabayko
maxsharabayko reviewed Jun 8, 2022
View reviewed changes
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ethouris
ethouris reviewed Jun 8, 2022
View reviewed changes
README.md Show resolved Hide resolved
ethouris
ethouris reviewed Jun 8, 2022
View reviewed changes
README.md Show resolved Hide resolved
@mbakholdina mbakholdina force-pushed the mbakholdina/readme-improvements branch 2 times, most recently from 176f99e to cd38f01 Compare June 9, 2022 11:48
mbakholdina
mbakholdina commented Jun 9, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
@mbakholdina mbakholdina force-pushed the mbakholdina/readme-improvements branch from cd38f01 to 66c3c58 Compare June 9, 2022 14:07
@mbakholdina mbakholdina force-pushed the mbakholdina/readme-improvements branch from 66c3c58 to 32cb172 Compare June 9, 2022 14:12
@maxsharabayko maxsharabayko merged commit 04b7c00 into Haivision:master Jun 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ethouris ethouris ethouris left review comments

@maxsharabayko maxsharabayko maxsharabayko left review comments

@stevomatthews stevomatthews stevomatthews left review comments

Assignees

@mbakholdina mbakholdina

Labels
[docs] Area: Improvements or additions to documentation Type: Enhancement Indicates new feature requests
Projects
None yet
Milestone
v1.5.0
Development

Successfully merging this pull request may close these issues.

[Docs] Improve README
4 participants
@mbakholdina @ethouris @maxsharabayko @stevomatthews