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 #649

Merged
merged 16 commits into from
Jul 13, 2022
Merged

Update readme #649

merged 16 commits into from
Jul 13, 2022

Conversation

FreezyLemon
Copy link
Contributor

After seeing that the README was pretty outdated, I decided to try and update it a bit. Some things I'm not 100% about:

  • The first few sentences. These are pretty important as far as READMEs go, so feel free to edit/propose stuff
  • Saying lsmash is the recommended choice. This just seemed like the generally preferred choice from what I read in Discord
  • I think "use av1an --help for a CLI reference" is easier to maintain than listing every option in the readme
  • Where to put the image of the 96-worker encode

Feel free to give feedback on these things and in general.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@redzic
Copy link
Collaborator

redzic commented Jul 9, 2022

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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jangrewe
Copy link

I would actually prefer to have the full --help output in the README, as an easy reference without having the run the command and scroll back and forth in the console all the time. It doesn't need to be nicely formatted, so putting the raw output into a code block would be good enough.

@FreezyLemon
Copy link
Contributor Author

@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 av1an --help instead of referencing the outdated information.

It's no real problem though, if you prefer a parameter reference that doesn't required running av1an then I can include it.

@FreezyLemon
Copy link
Contributor Author

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.

@FreezyLemon FreezyLemon marked this pull request as ready for review July 11, 2022 17:28
@master-of-zen
Copy link
Owner

I think preview image should be on top

Copy link
Collaborator

@redzic redzic left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@mergify mergify bot merged commit f9b51e3 into master-of-zen:master Jul 13, 2022
@FreezyLemon FreezyLemon deleted the update-readme branch July 13, 2022 11:26
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.

None yet

4 participants