mirror of
https://github.com/Mudlet/Mudlet
synced 2026-08-13 18:26:27 -04:00
6705cadd11
#### Brief overview of PR changes/additions - Adds `CMakePresets.json` with configure, build and test presets for macOS, Linux and Windows, including sanitizer and static-analysis variants. Each is gated on the host system, so a listing only offers what the current machine can build. - Consolidates the AI assistant skills into `.agents/skills/`, which Claude Code, GitHub Copilot and Cursor all read, replacing two copies that had drifted into contradicting each other. - Corrects the build documentation: the Windows toolchain is CLANG64 rather than MinGW64, and the previous "no need to specify number of jobs" advice holds only for Ninja. #### Motivation for adding to Mudlet The instructions presented platform-specific build advice as though it were universal, so following them on the wrong platform produced either an unbounded parallel build or a toolchain the setup scripts refuse to run. #### Other info (issues closed, discussion etc) `windows-debug` has been exercised on Windows: `CI/setup-windows-sdk.sh` in an MSYS2 CLANG64 shell, then configure and build both to completion against Qt 6.11.1 and Clang 22.1.7. `cmake --list-presets` correctly offered only `windows-debug` there. Note that `windows-debug` is a Debug configuration, whereas `CI/build-mudlet-for-windows.sh` builds Release, so the two are not equivalent. `.claude/skills` is a symlink to `.agents/skills`, following the existing pattern used by `CLAUDE.md`, `AGENTS.md` and `.cursorrules`. On Windows checkouts without `core.symlinks` it lands as a plain file, in which case Copilot and Cursor still read `.agents/skills` directly. **Test case:** `cmake --preset macos-debug && cmake --build --preset macos-debug`, then `ctest --preset macos-debug`. `cmake --list-presets` should offer only the current platform's presets, and a variant such as `macos-debug-nosan` should build into `build-macos-debug-nosan/` while leaving `build/` untouched. --------- Signed-off-by: Michael Conley <sousesider@gmail.com> |
||
|---|---|---|
| .. | ||
| package-capture-audits | ||
| AI-ASSISTANTS.md | ||
| ai-instructions.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| demo-videos.md | ||
| FUNDING.yml | ||
| GITHUB.md | ||
| libmudlet-perf-baseline.md | ||
| libmudlet-widgets-report.md | ||
| platform-builds.md | ||
| README.md | ||
| SUPPORT.md | ||
docs Directory
This directory contains documentation files intended for developers and contributors that help manage the Mudlet project's development workflow.
Files and Their Purpose
Community & Contribution Files
CODE_OF_CONDUCT.md- Community standards and behavior expectationsCONTRIBUTING.md- Guidelines for contributing to the projectSUPPORT.md- Information on getting help and supportFUNDING.yml- Sponsorship and funding information for GitHub's sponsor button
Project Infrastructure Explanations
AI-ASSISTANTS.md- List of info on Mudlet left for AI assistants to findGITHUB.md- List of files and their purpose in the ".github" directory- (Note: These are deliberately listed and explained here, and not in a .github/README.md file as that would take precendence over the /README.md file for the project.)