Add AGENTS.md #588
Add AGENTS.md #588
Conversation
This commit adds an AGENTS.md file to the root of the repository. It provides comprehensive instructions for AI agents on: - Project overview and engineering principles. - Dependency setup for Linux, Windows, macOS, and Android. - Build instructions for host and Android targets, specifying required compilers (Clang 19, VS 2022, AppleClang 17). - Code style guidelines (Google C++, clang-format 18.1.8, gersemi 0.23.1). - Testing procedures using ctest. - Contribution workflow.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
AGENTS.md
Outdated
| ```bash | ||
| sudo apt-get update | ||
| sudo apt-get install -y cmake ninja-build python3-mako | ||
| # Install Qt dependencies |
There was a problem hiding this comment.
Please include full installation instruction including qt.
There was a problem hiding this comment.
Added explicit instructions to install Qt via the online installer, as the apt-get commands only covered dependencies.
There was a problem hiding this comment.
Qt have apt packages, e.g. qtbase5-dev
There was a problem hiding this comment.
Updated Linux instructions to use qtbase5-dev package instead of the manual installer steps.
There was a problem hiding this comment.
apt-get will resolve dependencies, please remove unnecessary ones.
There was a problem hiding this comment.
Refined the installation command to rely on qtbase5-dev for resolving most dependencies, keeping only the non-standard ones explicit.
There was a problem hiding this comment.
Fixed the comment to say 'Install Qt' instead of 'Install Qt dependencies', since qtbase5-dev is the main Qt package.
AGENTS.md
Outdated
| ninja -C build | ||
| ``` | ||
|
|
||
| *Note: Replace `Debug` with `Release` for release builds.* |
There was a problem hiding this comment.
This is not specific to mac build.
There was a problem hiding this comment.
Clarified that the Android build script works on macOS as well.
There was a problem hiding this comment.
Removed both notes.
- Bumped minimum CMake version to 3.22. - Added explicit Qt installation instructions for Linux (Online Installer). - Clarified macOS Android build support.
- Switched Linux Qt installation to use `qtbase5-dev` apt package. - Removed redundant notes in macOS section.
hysw
left a comment
hysw
left a comment
There was a problem hiding this comment.
Have you verified these instruction works?
AGENTS.md
Outdated
| ```bash | ||
| sudo apt-get update | ||
| sudo apt-get install -y cmake ninja-build python3-mako | ||
| # Install Qt dependencies |
There was a problem hiding this comment.
apt-get will resolve dependencies, please remove unnecessary ones.
- Simplified Linux Qt dependency installation by relying on `qtbase5-dev`.
- Changed comment from 'Install Qt dependencies' to 'Install Qt' for accuracy.
1 participant
Created AGENTS.md to provide guidelines for AI agents working on the Dive project, including build instructions, code style, and testing procedures.
PR created automatically by Jules for task 9781090630076451770 started by @hysw