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 README #1253

Merged
merged 16 commits into from
Jul 3, 2024
Merged

Update README #1253

merged 16 commits into from
Jul 3, 2024

Conversation

randomPoison
Copy link
Collaborator

Update the README to better reflect the current state of the project and provide more information to users:

  • Remove note about the project being experimental now that we're largely production-ready.
  • Add a section with build instructions, noting the additional dependency on nasm.
  • Flesh out the section on testing to note the need to install meson, recommend the opt-dev profile, and document the extra args for test.sh.
  • Add usage instructions, mostly just documenting that we expose the same C API as dav1d.

Let me know if there's any other information I should add to the README.

Copy link
Collaborator

@kkysen kkysen left a comment

Choose a reason for hiding this comment

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

Could you wrap lines? The long lines are fine when rendered in Markdown, but they're annoying to comment on and diff. Line breaks at end of sentences or phrases would be good I think.

Also, can you mention the features that you can build with? So how to build without asm support, or build for only one bitdepth. That's different from dav1d so it seems appropriate here.

README.md Outdated 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
README.md Outdated 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
@randomPoison
Copy link
Collaborator Author

Could you wrap lines? The long lines are fine when rendered in Markdown, but they're annoying to comment on and diff. Line breaks at end of sentences or phrases would be good I think.

I've wrapped the lines at 80 characters wide. I'd prefer to do it that way over semantic wrapping because I can use a tool to update wrapping automatically.

Also, can you mention the features that you can build with? So how to build without asm support, or build for only one bitdepth. That's different from dav1d so it seems appropriate here.

Added.

README.md Outdated 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
README.md Outdated 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
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@randomPoison randomPoison requested review from rinon and kkysen July 2, 2024 23:47
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
@randomPoison randomPoison requested a review from kkysen July 3, 2024 16:40
Copy link
Collaborator

@thedataking thedataking left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

nit: One additional target we support is aarch64-linux-android (although running tests in Android is not there yet). Up to you whether to update the readme since we will also be adding x86_64-pc-windows-msvc in the near future.

@randomPoison
Copy link
Collaborator Author

nit: One additional target we support is aarch64-linux-android (although running tests in Android is not there yet). Up to you whether to update the readme since we will also be adding x86_64-pc-windows-msvc in the near future.

I'd say let's hold off on adding it, and add it to the README in the PR that adds CI coverage for it.

@randomPoison randomPoison merged commit b621cef into main Jul 3, 2024
27 checks passed
@randomPoison randomPoison deleted the legare/readme branch July 3, 2024 23:29
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

Successfully merging this pull request may close these issues.

4 participants