-
-
Notifications
You must be signed in to change notification settings - Fork 304
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.md #2518
base: main
Are you sure you want to change the base?
Update README.md #2518
Conversation
Re-structure the first page to be a bit more appealing - Regrouping getting started and fuzzer example in one sub-section - Separate installation guide in a different sub-section - Moving 'Why LibAFL'' further in the page - Removing spacing/newline to group info together
- Fixing typo - Improving layout
You removed the |
Ah you renamed it.. why not start with why libafl? |
|
I mean it's at the top so people who browse here the first time know why to stay... |
@domenukk understandable. I'll push new version with overview\whyLibAFL merged later today |
Cleaner readme - overview and why libafl merged - resources and quick started cleaned
- Build instruction before getting started
Feels like this version is clean. Lmk your opinion |
+ `QEMU` user-mode and system mode, including hooks for emulation, in [libafl_qemu](./libafl_qemu) | ||
+ `TinyInst`, in [libafl_tinyinst](./libafl_tinyinst) by [elbiazo](https://github.com/elbiazo) | ||
|
||
## Building and installing |
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.
Title case: Building and Installing
|
||
3. Build the library using | ||
|
||
#### Build the library using |
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.
Title case some more
|
||
4. Build the API documentation with | ||
|
||
#### Build the API documentation with |
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.
Title allthecase
Re-structure the first page to be a bit more appealing