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.

Sign up for GitHub

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

Jump to bottom

Docs update to improve UX #185

Open
brimigs opened this issue Jul 29, 2024 · 0 comments
Open

Docs update to improve UX #185

brimigs opened this issue Jul 29, 2024 · 0 comments

Comments

@brimigs
Copy link

brimigs commented Jul 29, 2024

It would be great to have additional information in the readme to make the new user onboarding as simplistic as possible. This would include:

  • hfuzz installation is a prereq for using this tool
    cargo install honggfuzz
  • Add in a quick summary at the top of the readme on what a fuzz test is for user unfamiliar
  • Add in a section for "how to use" that gives a UX walkthrough of the fuzz tester because using the tool without documentation isn't extremely intuitive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brimigs