Skip to content

docs: update README with auto-start info and security note - #33

Merged
beenycool merged 2 commits into
masterfrom
pr7-docs
Apr 17, 2026
Merged

docs: update README with auto-start info and security note#33
beenycool merged 2 commits into
masterfrom
pr7-docs

Conversation

@beenycool

@beenycool beenycool commented Apr 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • Update GUI instructions to mention automatic admin rights request
  • Add section on anti-virus false positives with Windows Defender

Summary by CodeRabbit

Documentation

  • Simplified GUI launch instructions - the application now automatically requests admin rights without requiring additional setup steps or external tools
  • Added "Security & Antivirus" section addressing potential antivirus false positives that may occur during operation and providing guidance for adding the application to Windows Defender exclusions

- Update GUI instructions to mention automatic admin rights
- Add section on anti-virus false positives
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai

coderabbitai Bot commented Apr 12, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@beenycool has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 59 minutes and 29 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 59 minutes and 29 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 15eff5a6-41ba-4dee-8f4e-a7a091573a79

📥 Commits

Reviewing files that changed from the base of the PR and between c9c4bdd and 43494f5.

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

Walkthrough

README updated with clarified GUI launch instructions stating that AsusFanControl.exe automatically requests admin rights, replacing RunAsAdmin.bat guidance. Added new "Security & Antivirus" section warning of potential false positives from AsusWinIO64.dll interaction and providing Windows Defender exclusion instructions.

Changes

Cohort / File(s) Summary
Documentation
README.md
Updated GUI run instructions to remove RunAsAdmin.bat reference and clarify automatic admin elevation. Added new "Security & Antivirus" section addressing antivirus false positive concerns related to DLL interaction with Windows Defender exclusion guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A fan control tale with care,
No more scripts, just admin air!
Windows guards may raise a brow,
But our DLL's welcome now! 🎫✨

🚥 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 accurately reflects the main changes: updating README with information about automatic admin rights request and security concerns related to antivirus.
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 pr7-docs

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.

@kilo-code-bot

kilo-code-bot Bot commented Apr 12, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Overview

This PR makes improvements to the README.md documentation:

  1. Line 22: Updated the GUI instructions to clarify that admin rights are automatically requested when running with no arguments. This is more accurate and user-friendly than the previous text which referenced RunAsAdmin.bat as an alternative.

  2. Lines 39-42: Added a new "Security & Antivirus" section explaining that anti-viruses like Windows Defender may falsely flag the application as malicious due to its interaction with hardware-level drivers. The section provides helpful guidance for users who encounter this issue.

Both changes are clear, accurate, and improve the user experience. No issues were found in the documentation updates.

Files Reviewed (1 file)
  • README.md - No issues

Reviewed by trinity-large-thinking · 92,471 tokens

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 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`:
- Around line 39-40: Insert a single blank line immediately after the "###
Security & Antivirus" heading in README.md to satisfy markdownlint rule MD022
(blanks-around-headings); locate the heading text "### Security & Antivirus" and
add an empty line before the following paragraph about AsusWinIO64.dll so the
heading is separated from the paragraph.
🪄 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: 19502c8b-558e-432e-8804-6e289900e3de

📥 Commits

Reviewing files that changed from the base of the PR and between a469e19 and c9c4bdd.

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

Comment thread README.md Outdated
Comment on lines +39 to +40
### Security & Antivirus
Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.

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

Add a blank line after the heading to satisfy markdownlint.

At Line 39, insert an empty line before the paragraph (Line 40) to resolve MD022 (blanks-around-headings).

Suggested fix
 ### Security & Antivirus
+
 Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Security & Antivirus
Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.
### Security & Antivirus
Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 39-39: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

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

In `@README.md` around lines 39 - 40, Insert a single blank line immediately after
the "### Security & Antivirus" heading in README.md to satisfy markdownlint rule
MD022 (blanks-around-headings); locate the heading text "### Security &
Antivirus" and add an empty line before the following paragraph about
AsusWinIO64.dll so the heading is separated from the paragraph.

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the README.md to reflect that the application now automatically requests administrator privileges and adds a new section regarding potential antivirus false positives. The review feedback suggests clarifying that the elevation requirement applies to the entire application (both GUI and CLI) and generalizing the security advice to include all antivirus software rather than just Windows Defender.

Comment thread README.md
</details>

GUI: run `AsusFanControl.exe` with no arguments (or use `RunAsAdmin.bat` where provided).
GUI: run `AsusFanControl.exe` with no arguments (it will automatically request admin rights).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The note about automatically requesting admin rights is placed specifically under the GUI section. However, since the GUI and CLI share the same executable, any elevation mechanism (like an application manifest) will trigger a UAC prompt for both modes. It would be more accurate to state that the application itself requires administrator privileges. Additionally, the PR title mentions 'auto-start', which usually refers to starting with Windows, whereas this change is about 'auto-elevation'.

Suggested change
GUI: run `AsusFanControl.exe` with no arguments (it will automatically request admin rights).
GUI: run AsusFanControl.exe with no arguments (the application will automatically request admin rights).

Comment thread README.md Outdated
Comment on lines +40 to +41
Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.
If you experience this issue, please add the executable to your Windows Defender exclusions.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Improved the technical accuracy regarding the DLL and generalized the antivirus advice. AsusWinIO64.dll is a library that interfaces with a driver, and users may use antivirus software other than Windows Defender.

Suggested change
Because this application interacts with hardware-level drivers (`AsusWinIO64.dll`), anti-viruses such as Windows Defender might falsely flag it as malicious.
If you experience this issue, please add the executable to your Windows Defender exclusions.
Because this application interacts with hardware-level drivers via AsusWinIO64.dll, antivirus software such as Windows Defender might falsely flag it as malicious.
If you experience this issue, please add the executable to your antivirus exclusions.

@beenycool
beenycool merged commit e9c0915 into master Apr 17, 2026
3 checks passed
@beenycool
beenycool deleted the pr7-docs branch April 17, 2026 07:18
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