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

Update README.md #2518

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update README.md #2518

wants to merge 5 commits into from

Conversation

20urc3
Copy link
Contributor

@20urc3 20urc3 commented Sep 9, 2024

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

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
@domenukk
Copy link
Member

You removed the ## Resources section (?)

@domenukk
Copy link
Member

Ah you renamed it.. why not start with why libafl?

@20urc3
Copy link
Contributor Author

20urc3 commented Sep 10, 2024

  • I merged resource with quick start, feels like it is a bit more appealing for people to see examples and tutorials together
  • The why LibAFL section is a bit verbose and more "in-depth" so in my opinion placing it after the catchy content was more relevant. The ideal scenario in my opinion would be to re-structure overview and why libafl to be one (a bit shorter) section (I can do that today)

@domenukk
Copy link
Member

I mean it's at the top so people who browse here the first time know why to stay...

@20urc3
Copy link
Contributor Author

20urc3 commented Sep 10, 2024

@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
@20urc3
Copy link
Contributor Author

20urc3 commented Sep 10, 2024

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title allthecase

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

Successfully merging this pull request may close these issues.

2 participants