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

reorganize and extend readme #2258

Merged
merged 4 commits into from
Aug 12, 2024
Merged

reorganize and extend readme #2258

merged 4 commits into from
Aug 12, 2024

Conversation

mr-tz
Copy link
Collaborator

@mr-tz mr-tz commented Aug 9, 2024

Checklist

  • No CHANGELOG update needed
  • No new tests needed
  • No documentation update needed

@mr-tz mr-tz requested review from williballenthin and fariss August 9, 2024 09:19
mr-tz
mr-tz commented Aug 9, 2024
View reviewed changes
README.md
@@ -72,16 +74,19 @@ Download stable releases of the standalone capa binaries [here](https://github.c

To use capa as a library or integrate with another tool, see [doc/installation.md](https://github.com/mandiant/capa/blob/master/doc/installation.md) for further setup instructions.

For more information about how to use capa, see [doc/usage.md](https://github.com/mandiant/capa/blob/master/doc/usage.md).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

there's not really useful (basic) usage information in here - more so various tips

fariss
fariss approved these changes Aug 9, 2024
View reviewed changes
Copy link
Collaborator

@fariss fariss left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @mr-tz.
Maybe we could remove the tool specification here and leave it open?

capa/README.md

Line 89 in ea9853e

- it shows where within the binary an experienced analyst might study with IDA Pro

@mr-tz
Copy link
Collaborator Author

mr-tz commented Aug 9, 2024

IMHO it's fine to leave as is.

@fariss fariss mentioned this pull request Aug 9, 2024
Merged
3 tasks
williballenthin
williballenthin reviewed Aug 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
williballenthin
williballenthin reviewed Aug 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
williballenthin
williballenthin reviewed Aug 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
williballenthin
williballenthin approved these changes Aug 9, 2024
View reviewed changes
Copy link
Collaborator

@williballenthin williballenthin left a comment

Choose a reason for hiding this comment

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

see inline comments.

but i'd rather have some progress committed then waiting for things to be perfect, so merge when you see fit! we can keep wordsmithing continuously.

@mr-tz
Copy link
Collaborator Author

mr-tz commented Aug 10, 2024

Yes, all great points and ideally we refine the readme and documentation here a bit more thorough very soon. I'll make appropriate changes, open issues, and merge here then.

This was referenced Aug 12, 2024
Closed
Open
@mr-tz mr-tz mentioned this pull request Aug 12, 2024
Open
3 tasks
@mr-tz mr-tz merged commit 239ad4a into master Aug 12, 2024
5 checks passed
@mr-tz mr-tz deleted the update-readme branch August 12, 2024 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fariss fariss fariss approved these changes

@williballenthin williballenthin williballenthin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mr-tz @williballenthin @fariss