-
Notifications
You must be signed in to change notification settings - Fork 163
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 #649
Update readme #649
Conversation
Overall I think this looks very good. I do wonder if we could also add some instructions for how to install lsmash and/or ffms2 on Windows. Basically the user just needs to put some DLL files into their vapoursynth plugins directory, but most users probably wouldn't know that in addition to knowing where to find the DLLs. |
I would actually prefer to have the full |
@jangrewe I don't mind including the --help output somewhere, and spending some time on formatting isn't really an issue either. The main reason that I removed the old "parameter block" from the readme was the lack of maintenance. There was a lot of missing and some wrong information, so I thought it would be better to just tell people to use It's no real problem though, if you prefer a parameter reference that doesn't required running av1an then I can include it. |
Well, I think with the last commit I'm pretty much done for now. Feels a bit bad to leave the image at the bottom, but it doesn't really fit anywhere else. |
I think preview image should be on top |
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.
Looks good, thanks!
After seeing that the README was pretty outdated, I decided to try and update it a bit. Some things I'm not 100% about:
lsmash
is the recommended choice. This just seemed like the generally preferred choice from what I read in Discordav1an --help
for a CLI reference" is easier to maintain than listing every option in the readmeFeel free to give feedback on these things and in general.