Tutorial_AwesomeModernCPP AGENTS.md

A project guide for AI coding agents working on a Chinese-language Modern C++ tutorial, built with VitePress and containing CMake examples for computers and STM32 microcontrollers.

In plain words
What is it for?
It helps maintain tutorials, validate Markdown metadata, build the documentation site, and compile or review C++ examples.
Why use it?
It reduces project mistakes by documenting the required tools, build commands, validation steps, and rules for checking C++ behavior.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/awesome-embedded-learning-studio/tutorial_awesomemoderncpp/agents-md
Clone the repo
git clone --depth 1 https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP

Made for: Codex, OpenCode.

Per session 778 This file is loaded in full into every session.
When invoked 778 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00778 $0.00778
Opus 5 $0.00389 $0.00389
Sonnet 5 $0.00156 $0.00156
Haiku 4.5 $0.00078 $0.00078

Measured 2d ago against content hash a5fe652debc4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Tutorial_AwesomeModernCPP AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 34 lines

What it actually says

AGENTS.md

任何 AI coding agent(Claude Code / Cursor / Copilot / Codex / Windsurf …)的项目入口,人也适用。一个 vendor-neutral 文件,所有 agent 都读。Claude 专属补充另见 CLAUDE.md

这是什么

Tutorial_AwesomeModernCPP —— 从 C++ 基础到嵌入式实战的系统化 Modern C++ 教程(C++11–C++23,9 卷约 155 篇),VitePress 构建 + CMake 代码示例(支持 host / STM32F1 / STM32F4),部署 GitHub Pages。主语言中文。

documents/                vol1..vol9 + compilation + projects + images + community  ← 文档源
site/.vitepress/          VitePress 配置(nav / sidebar / theme / plugins)
scripts/                  build.ts(分卷并行构建)、validate_frontmatter.py …
code/volumn_codes/        各卷可编译示例(无根 CMakeLists,逐目录构建)

通用 essentials(所有 agent 必读)

  • Python 一律用 .venv/bin/python(根目录 .venv,Python 3.14 + PyYAML)。严禁裸 python / python3 —— 系统 python 缺 PyYAML,会让 validate_frontmatter.py 把全仓文件误报成 error。(Claude Code 侧有 PreToolUse hook 强制拦截。)
  • 金科玉律 · 信息校验:凡断言 C++ 行为,先编译实测或查 cppreference 并标标准版本。C++ 语义随版本 / 实现变化,禁止凭记忆断言。验证代码只写 /tmp/,不要在项目目录跑 cmake / make / build(会污染仓库)。
  • 构建 / 校验:pnpm installpnpm dev(热更新预览)/ pnpm build(分卷并行);markdownlint documents/**/*.md;.venv/bin/python scripts/validate_frontmatter.py
  • 谨慎区:compilation/ 卷已完成,改动需特别谨慎;vol1-fundamentals/ 正在重写,注意与已有内容衔接。

你来做什么?(按场景路由)

场景 去哪
贡献文章 / 代码示例 CONTRIBUTING.md —— 流程一条龙
写作人格 / 语气 / 文章骨架 / 代码风格 .claude/style/writing-style.md
Frontmatter 字段与标签体系 .claude/rules/documents-frontmatter.md
辅助 C++ 学习者(学习辅助 track) .github/learning-with-agents.md + FAQ
复用本项目 Claude 资产(commands / prompts / hooks) CLAUDE.md.claude/

写作流程里的两条通用纪律也适用所有 agent:写作前先 web search 核准确性;完成后自查并告知如何验证,别把检查留给作者。

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 34 lines · 778 tokens per session scan A a5fe652debc4

Subscribe to this mod's changes

Tutorial_AwesomeModernCPP AGENTS.md is an instructions file published in the GitHub repository Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP (250 stars, last pushed 3d ago), licensed MIT. It adds 778 tokens to every session, about $0.0039 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

nim_duilib CLAUDE.md

Instructions for rhett-lee/nim_duilib, covering nimduilib - 跨平台 c++ ui 库, 项目概述, 项目结构, 开发模式(xml + c++) and xml 布局文件.

rhett-lee/nim_duilib · 1,161 tokens

cpp-lectures-mcp CLAUDE.md

Claude Code instructions for Alexvozhak/cpp-lectures-mcp, covering cpp-lectures-mcp, старт сессии, распределение ответственности по докам, рабочий цикл (кратко; полно — в skill.md) and инструменты (зафиксировано планом).

Alexvozhak/cpp-lectures-mcp · 3,342 tokens

ai-for-modern-cpp AGENTS.md

AGENTS.md instructions for thecompez/ai-for-modern-cpp, covering agents.md, modern c++ agent knowledge contract, 1. normative language and authority, 2. repository knowledge model and project initiation gate.

thecompez/ai-for-modern-cpp · 11,118 tokens

ai-for-modern-cpp CLAUDE.md

Claude Code instructions for thecompez/ai-for-modern-cpp, a project described as: A template repository for guiding AI coding agents to write safe, modern C++20/23/26 code using modules, concepts, modern CMake, Core Guidelines, tests, and repeatable build-test-review loops.

thecompez/ai-for-modern-cpp · 66 tokens

open-dictionary AGENTS.md

Instructions for ahpxex/open-dictionary, covering open dictionary rewrite charter, product framing, core workflow, technical framework and 1. raw ingestion layer.

ahpxex/open-dictionary · 1,906 tokens

designing-real-world-ai-agents-workshop CLAUDE.md

Instructions for iusztinpaul/designing-real-world-ai-agents-workshop, covering project, project structure, tech stack, access documentation and running qa.

iusztinpaul/designing-real-world-ai-agents-workshop · 839 tokens