-
Notifications
You must be signed in to change notification settings - Fork 22
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
Update README #1253
Conversation
There was a problem hiding this 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.
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.
Added. |
There was a problem hiding this 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.
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. |
Update the README to better reflect the current state of the project and provide more information to users:
test.sh
.Let me know if there's any other information I should add to the README.