Update README.md #2518
Merged
Update README.md #2518
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
domenukk
reviewed
Sep 10, 2024
| + `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.
Title case: Building and Installing
domenukk
reviewed
Sep 10, 2024
|
|
||
| 3. Build the library using | ||
|
|
||
| #### Build the library using |
domenukk
reviewed
Sep 10, 2024
|
|
||
| 4. Build the API documentation with | ||
|
|
||
| #### Build the API documentation with |
domenukk
reviewed
Sep 20, 2024
README.md
Outdated
| + `SanitizerCoverage`, in [libafl_targets](./libafl_targets) | ||
| + `Frida`, in [libafl_frida](./libafl_frida) | ||
| + `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) | ||
|
|
||
| LibAFL gives you many of the benefits of an off-the-shelf fuzzer, while being completely customizable. |
There was a problem hiding this comment.
I think we should keep this as extra section, the new Overview section is too big IMHO
There was a problem hiding this comment.
@20urc3 want to split them again? Then I can merge this PR :)
- Separate Why LibAFL and Overview section
tokatoka
reviewed
Sep 26, 2024
README.md
Outdated
| + [Online API documentation](https://docs.rs/libafl/) | ||
|
|
||
| + The LibAFL book (WIP) [online](https://aflplus.plus/libafl-book) or in the [repo](./docs/src/) | ||
| ### Ressources |
There was a problem hiding this comment.
@tokatoka Thanks for the merge! The latest version correspond more to what Dom asked :-)
|
Should be good for you now @domenukk |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re-structure the first page to be a bit more appealing