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

Fix usage in README.md #314

Closed
benoit74 opened this issue Jun 7, 2024 · 1 comment · Fixed by #347
Closed

Fix usage in README.md #314

benoit74 opened this issue Jun 7, 2024 · 1 comment · Fixed by #347
Assignees
Labels
Milestone

Comments

@benoit74
Copy link
Collaborator

benoit74 commented Jun 7, 2024

Usage section of README.md is quite confusing:

  • it mention that it is possible to run warc2zim --help while this is both not working (you need to be inside the venv) + mostly useless (very few users will come with an existing WARC file)
  • the shm-size parameter is not needed anymore, browsertrix crawler uses by default the new --disable-dev-shm-usage
  • it mention many parameters (shm-size, workers, waitUntil) which are not strictly needing, adding more confusion than necessary
  • it mention the --scroll parameter which does not exists
  • probably other stuff to fix as well
@benoit74 benoit74 added the bug label Jun 7, 2024
@benoit74 benoit74 added this to the 2.1.0 milestone Jun 7, 2024
@benoit74 benoit74 self-assigned this Jun 7, 2024
@rgaudin
Copy link
Member

rgaudin commented Jun 7, 2024

it mention that it is possible to run warc2zim --help while this is both not working (you need to be inside the venv) + mostly useless (very few users will come with an existing WARC file)

To me this is a regression. zimit image is very convenient way to use warc2zim for WARC users. I think we should keep the feature (and it's as cheap as a symlink!)

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

Successfully merging a pull request may close this issue.

2 participants