Skip to content

update installation instructions for Windows/Mac#532

Merged
nschimme merged 5 commits into
MUME:masterfrom
nschimme:update-docs-install-instructions-13094904216487701619
May 18, 2026
Merged

update installation instructions for Windows/Mac#532
nschimme merged 5 commits into
MUME:masterfrom
nschimme:update-docs-install-instructions-13094904216487701619

Conversation

@nschimme

@nschimme nschimme commented May 18, 2026

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Update platform-specific installation documentation for unsigned Windows and macOS builds.

Documentation:

  • Clarify Windows installation steps for unsigned executables, including handling Microsoft Edge download blocks and SmartScreen warnings.
  • Revise macOS installation instructions to reflect current workflow for opening non-notarized apps via Privacy & Security settings and Open Anyway, and to clarify that the process applies per new version.

nschimme and others added 5 commits April 21, 2026 11:41
- Enable windows-2022 clang target in build-test matrix.
- Implement robust recursive discovery of LLVM-MinGW toolchain under C:\Qt.
- Set CC and CXX to absolute paths of clang/clang++ executables.
- Enable ASAN and UBSAN for Windows Debug builds when using Clang.
- Ensure sanitizers remain disabled for Windows GCC to avoid regressions.
- Standardize PowerShell exit codes to 1 for failures.

* ci: add windows clang target and enable address sanitizer

- Enable windows-2022 clang target in build-test matrix.
- Implement robust recursive discovery of LLVM-MinGW toolchain under C:\Qt.
- Set CC and CXX to absolute paths of clang/clang++ executables.
- Enable ASAN and UBSAN for Windows Debug builds when using Clang.
- Exclude --compiler-runtime from windeployqt for Clang on Windows.
- Ensure sanitizers remain disabled for Windows GCC to avoid regressions.
- Added `/fsanitize=address` and `/Oy-`.
- Explicitly removed `/RTC1` as it's incompatible with ASAN.
- Set `/INCREMENTAL:NO` for the linker.
…t Edge

Update docs/macos.md and docs/windows.md with modern instructions for
bypassing security blocks.

On macOS, the right-click workaround is replaced by the System Settings
"Open Anyway" method, which requires an initial failed launch attempt
to trigger the setting.

On Windows, explicit steps are added for bypassing Microsoft Edge's
download block (Keep -> Show more -> Keep anyway), in addition to
SmartScreen and manual file unblocking instructions.

The instructions maintain the original descriptive style and layout
as requested.
…t Edge

Update docs/macos.md and docs/windows.md with modern instructions for
bypassing security blocks.

On macOS, the right-click workaround is replaced by the System Settings
"Open Anyway" method. On Windows, explicit steps are added for bypassing
Microsoft Edge's download block and SmartScreen warnings.

Note: Previous CI failure in build-snap was a transient network error
(Connection failed while fetching libssl3t64) and is unrelated to these
documentation changes.
@sourcery-ai

sourcery-ai Bot commented May 18, 2026

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

Reviewer's Guide

Updates Windows and macOS installation notices to give more concrete, modern instructions for dealing with unsigned/notarized binaries, including browser- and OS-level security prompts, and clarifies that the process is required once per new version.

File-Level Changes

Change Details Files
Revise Windows installation notice to cover Edge download blocking and SmartScreen warnings with step-by-step recovery instructions.
  • Change heading text to address all Windows users and mention potential Edge/SmartScreen blocking.
  • Replace generic file properties/unblock steps with explicit instructions for allowing blocked downloads in Edge.
  • Add explicit instructions for bypassing Windows SmartScreen via the More info → Run anyway path.
  • Keep a final fallback using the file Properties → Unblock checkbox if the installer still does not run.
  • Clarify that these steps are needed only once per new version.
docs/windows.md
Revise macOS installation notice to match current macOS behavior for unnotarized apps, using Privacy & Security → Open Anyway flow.
  • Make the language stronger that macOS will block the app by default if not notarized.
  • Simplify initial steps to just dragging the app to Applications before first run.
  • Replace right-click Open flow with the modern Privacy & Security → Open Anyway sequence after the first launch attempt.
  • Remove the previous alternative-flow note and consolidate instructions into the main ordered list.
  • Clarify that these steps are needed only once per new version of MMapper.
docs/macos.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

@nschimme nschimme merged commit 90eb09d into MUME:master May 18, 2026
19 checks passed

@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 - I've left some high level feedback:

  • On macOS, changing the wording from “might prevent” to “will prevent” could be misleading for users with different Gatekeeper/security settings; consider reverting to softer language like “may prevent it from opening directly.”
  • The Windows instructions focus specifically on Microsoft Edge; if users commonly download via other browsers, consider adding a brief, generic note about similar security prompts in other browsers or clarifying that these steps apply when using Edge.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- On macOS, changing the wording from “might prevent” to “will prevent” could be misleading for users with different Gatekeeper/security settings; consider reverting to softer language like “may prevent it from opening directly.”
- The Windows instructions focus specifically on Microsoft Edge; if users commonly download via other browsers, consider adding a brief, generic note about similar security prompts in other browsers or clarifying that these steps apply when using Edge.

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.

@nschimme nschimme deleted the update-docs-install-instructions-13094904216487701619 branch May 18, 2026 19:22
@codecov

codecov Bot commented May 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 25.36%. Comparing base (4f57972) to head (723fb2a).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #532      +/-   ##
==========================================
- Coverage   25.36%   25.36%   -0.01%     
==========================================
  Files         519      519              
  Lines       43181    43185       +4     
  Branches     4705     4706       +1     
==========================================
  Hits        10952    10952              
- Misses      32229    32233       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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