Skip to content

docs: fix readme commands#23

Merged
ErenayDev merged 1 commit intomasterfrom
docs/readme-fix
Apr 12, 2026
Merged

docs: fix readme commands#23
ErenayDev merged 1 commit intomasterfrom
docs/readme-fix

Conversation

@ErenayDev
Copy link
Copy Markdown
Owner

@ErenayDev ErenayDev commented Apr 12, 2026

Summary by Sourcery

Documentation:

  • Clarify Arch Linux installation by specifying the pacman package name and documenting yay-based installation.

Summary by CodeRabbit

  • Documentation
    • Clarified the installation command for Arch Linux users using pacman with the specific package name.
    • Added an alternative installation method using yay, providing users with additional options for installing from the AUR on Arch systems.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Apr 12, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README installation instructions for Arch Linux to specify the correct pacman package name and add an alternative installation method using yay.

File-Level Changes

Change Details Files
Correct Arch Linux pacman installation command.
  • Update pacman command to explicitly install the cachefetch-bin package instead of leaving the package name blank
README.md
Add yay-based installation instructions for Arch Linux users.
  • Document an alternative installation method using yay with the cachefetch package
  • Introduce a new bash code block showing the yay command
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

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 12, 2026

📝 Walkthrough

Walkthrough

Updated the README.md installation documentation to clarify the Arch Linux pacman command and added an alternative yay installation method for AUR users, improving the package installation instructions.

Changes

Cohort / File(s) Summary
Documentation Update
README.md
Corrected Arch Linux installation command to explicitly specify cachefetch-bin package and added yay -S cachefetch as an alternative installation method for AUR users.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hops with glee, the README shines so bright,
Installation paths now crystal clear and right!
From pacman to yay, we've cleared the way,
For Arch users now, a cleaner day!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix readme commands' accurately describes the main change: correcting documentation commands in the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-fix
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/readme-fix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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


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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 22: Remove the leading shell prompt from the inline command examples to
satisfy markdownlint MD014: locate the occurrences of "$ sudo pacman -S
cachefetch-bin" (and the similar line at the other occurrence) in README.md and
replace them with the plain command "sudo pacman -S cachefetch-bin" (i.e.,
remove the "$ " prefix) so the code blocks contain just the command text for
easier copy/paste.
- Around line 41-45: The "yay -S cachefetch" command is an AUR install path but
is placed under the "From Source" section; update README.md by moving that code
block out of the "From Source" subsection or relabeling it (e.g., add a new
subsection titled "Arch Linux / AUR" or change the heading to "From AUR (Arch
Linux)") and update the accompanying text to make clear this uses an AUR helper
(`yay -S cachefetch`) rather than building from source.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: f0f98063-b594-4957-862c-a7b34f2056b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1c97aeb and cc0a46b.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md

```sh
$ sudo pacman -S
$ sudo pacman -S cachefetch-bin
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove shell prompts from command blocks (markdownlint MD014).

Line 22 and Line 44 include $ prompts even though no command output is shown, which triggers MD014 and reduces copy/paste friendliness.

Suggested diff
- $ sudo pacman -S cachefetch-bin
+ sudo pacman -S cachefetch-bin
...
- $ yay -S cachefetch
+ yay -S cachefetch

Also applies to: 44-44

🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 22-22: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 22, Remove the leading shell prompt from the inline
command examples to satisfy markdownlint MD014: locate the occurrences of "$
sudo pacman -S cachefetch-bin" (and the similar line at the other occurrence) in
README.md and replace them with the plain command "sudo pacman -S
cachefetch-bin" (i.e., remove the "$ " prefix) so the code blocks contain just
the command text for easier copy/paste.

Comment thread README.md
Comment on lines +41 to +45
Or with `yay`

```bash
$ yay -S cachefetch
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Clarify that this is an AUR install path, not “From Source.”

This block appears under “From Source” but uses yay (AUR flow). Please relabel/move it to avoid misleading users.

Suggested wording
-Or with `yay`
+Or install from AUR with `yay`:
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 44-44: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 41 - 45, The "yay -S cachefetch" command is an AUR
install path but is placed under the "From Source" section; update README.md by
moving that code block out of the "From Source" subsection or relabeling it
(e.g., add a new subsection titled "Arch Linux / AUR" or change the heading to
"From AUR (Arch Linux)") and update the accompanying text to make clear this
uses an AUR helper (`yay -S cachefetch`) rather than building from source.

@ErenayDev ErenayDev merged commit ce9eae8 into master Apr 12, 2026
9 checks passed
@ErenayDev ErenayDev deleted the docs/readme-fix branch April 12, 2026 08:52
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.

1 participant