Skip to content

Rewrite README for clarity and maintainability #13

Description

@vincentcr

Goal
Replace the current accumulated README with a concise, human-shaped explanation of what scanbox does, who it is for, and how to use it.

Scope

  • Rewrite rather than incrementally patch the existing narrative.
  • Lead with supported user workflows and current limitations.
  • Explain WSD versus legacy HPLIP in plain language.
  • Keep installation, setup, scanning, dynamic scanner selection, output defaults, and troubleshooting easy to find.
  • Preserve genuinely useful hardware findings and operational caveats without turning the README into an implementation diary.
  • Remove repetition, speculative claims, excessive asides, and generated-sounding filler.
  • Ensure every command and configuration example matches the final CLI.
  • Keep detailed internals in focused technical documentation where appropriate.

Acceptance criteria

  • A new user can determine within a minute whether scanbox supports their scanner.
  • The primary setup and scan paths are short and accurate.
  • Supported backends and VM requirements are stated precisely.
  • Legacy HP behavior and current-LAN WSD behavior are both documented.
  • Deferred native AirScan support is described only as future work, not as a current capability.
  • README examples are exercised against the final CLI.

Ordering
Do this last, after routing, lazy provisioning, and final cross-backend verification are complete.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions