Skip to content

Update Readme#72

Merged
MusicalNinjaDad merged 3 commits into
mainfrom
readme
Oct 27, 2025
Merged

Update Readme#72
MusicalNinjaDad merged 3 commits into
mainfrom
readme

Conversation

@MusicalNinjaDad

@MusicalNinjaDad MusicalNinjaDad commented Oct 27, 2025 •
edited by sourcery-ai Bot
Loading

Copy link
Copy Markdown
Owner

Summary by Sourcery

Update README to reflect new CLI flags and usage patterns, clarify output destinations, and remove outdated notes.

Documentation:

  • Document new --in-place flag to limit snagging to dependencies and interpreter.
  • Document new --recursive flag for recursive directory snagging.
  • Add separate usage forms for file and directory modes with error behavior.
  • Clarify that executables go to DESTINATION/bin and dynamic libraries (*.so) to DESTINATION/lib64.
  • Simplify filesystem note to reference FILE/DIRECTORY and DESTINATION.
  • Remove outdated future feature for copying manually installed /opt files.

@MusicalNinjaDad MusicalNinjaDad enabled auto-merge (squash) October 27, 2025 19:46
@sourcery-ai

sourcery-ai Bot commented Oct 27, 2025 •
edited
Loading

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR refines the README usage documentation by updating the command examples, adding and documenting new flags, clarifying behavior for file versus directory modes, reorganizing file-to-destination mappings, and cleaning up notes and future sections.

File-Level Changes

Change Details Files
Revised usage section and command synopsis
  • Updated example prompt hash
  • Modified synopsis to include [--in-place] and [--recursive] flags
  • Reformatted usage lines for clarity
 README.md
Extended flags list with new options
  • Added --in-place flag description
  • Introduced -r, --recursive flag
  • Adjusted spacing for -h, --help entry
 README.md
Clarified FILE vs DIRECTORY modes
  • Separated behavior into two forms with headings
  • Specified error on non-ELF FILE input
  • Detailed recursive snagging for DIRECTORY
 README.md
Updated file-to-destination mapping style
  • Replaced inline mapping with bullets
  • Distinguished executables vs dynamic libraries
  • Standardized DESTINATION/bin and DESTINATION/lib64 labels
 README.md
Cleaned up notes and future sections
  • Simplified hardlink vs copy conditions
  • Removed outdated heuristic note
  • Trimmed future features list
 README.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai Bot reviewed Oct 27, 2025
View reviewed changes

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents 
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `README.md:23-25` </location>
<code_context>
+
+
+In the form "snaggle FILE DESTINATION":
+  FILE and all dependecies will be snagged to DESTINATION.
+  An error will be returned if FILE is not a valid ELF binary.

</code_context>

<issue_to_address>
**issue (typo):** Typo: 'dependecies' should be 'dependencies'.

Update the spelling to 'dependencies'.

```suggestion
In the form "snaggle FILE DESTINATION":
  FILE and all dependencies will be snagged to DESTINATION.
  An error will be returned if FILE is not a valid ELF binary.
```
</issue_to_address>
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md
@MusicalNinjaDad MusicalNinjaDad enabled auto-merge (squash) October 27, 2025 19:48
@MusicalNinjaDad MusicalNinjaDad merged commit 9053452 into main Oct 27, 2025
10 checks passed
@MusicalNinjaDad MusicalNinjaDad deleted the readme branch October 27, 2025 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@MusicalNinjaDad