iharhl/memmap

选用指南

AI 根据 README 整理 · 2026/11/3 13:36:55

使用方式

通过命令行使用，提供render、check、describe等子命令，支持SVG、PNG、PDF输出。

查看 README 依据

uv run memmap describe layout.yaml ``` ```bash uv run memmap render layout.yaml -o layout.svg ``` | Command | Purpose | | --- | --- | | `memmap render CONFIG [-o OUT] [--format svg\|png\|pdf] [--json] [--strict] [--set key=value]` | Validate, then draw; `--strict` fails on warnings | | `memmap check CONFIG [--json] [--strict]` | Validate only; `--strict` fails on warnings | | `memmap describe CONFIG [--json]` | Resolved regions, blocks, labels and option origins | | `memmap schema` | JSON Schema of the config | | `memmap guide` | Print the agent guide, for agents using an installed copy |

部署要求

需要Python环境，使用uv管理依赖；PNG和PDF输出需要额外的raster依赖和系统cairo库，macOS需设置DYLD_FALLBACK_LIBRARY_PATH。

查看 README 依据

 ## Install ```bash uv sync ``` PNG and PDF output needs the `raster` extra and the system cairo library: ```bash uv sync --extra raster ``` On macOS with Homebrew's cairo, the library is not on the default search path, so set this before rendering PNG or PDF: ```bash export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib ``` ## Use Start from the closest config in [examples/](examples/), listed under [Examples](#examples): ```bash cp examples/custom_bootloader.yaml layout.yaml ``` ```bash uv run memmap check layout.yaml ``` ```bash

已知限制

文本测量使用内置Helvetica/Arial宽度表，对其他字体的换行略有近似。

查看 README 依据

```bash uv run ruff check ``` Golden SVGs live in `tests/golden/`. After an intended drawing change, review the diff and regenerate them: ```bash MEMMAP_UPDATE_GOLDEN=1 uv run pytest tests/test_golden.py ``` Text is measured with a built-in Helvetica/Arial width table, so wrapping is slightly approximate for other fonts.