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.

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

Update the README file #29

Open
nicolaslevy opened this issue Jan 10, 2025 · 1 comment
Open

Update the README file #29

nicolaslevy opened this issue Jan 10, 2025 · 1 comment
Assignees

Comments

@nicolaslevy
Copy link
Collaborator

Currently, the README does not reflect the current state of the project. For example, it mentions that the project can be tested on quic.video, but in reality, quic.video showcases the repository prior to the fork by Kixelated.

I believe the new README should:

  • Mention that this repository is aligned with the IETF drafts of MoQ and include links to those drafts.
  • Explain the system for tagging the different IETF drafts, in case someone wants to test a specific draft, like draft-04 of MoQ.
  • Mention that this project can be tested alongside englishm/moq-rs.
  • Provide instructions for setting up the development environment, suggesting and explaining how to start moq-rs.
  • Explain the structure of the project, specifically noting that the library (lib) contains the player.
  • Include instructions for building the player.

Any other ideas to include?

@englishm englishm self-assigned this Jan 16, 2025
@JoaquinBCh
Copy link
Contributor

JoaquinBCh commented Jan 28, 2025

@englishm I've updated the README in this PR. Please review it when you have a chance. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants