From 3eaeda40e2a9dc7135557f7daf77b186463e4a0c Mon Sep 17 00:00:00 2001 From: everettjf Date: Thu, 21 May 2026 20:46:26 -0700 Subject: [PATCH] docs: drop broken WeChat image; reorder README sections - Remove the WeChat subscription block from Support; its pointed at image/wechat.png (the file lives at repo root), so it rendered broken. - Reorder for a get-started-first flow: Quick Start now precedes How It Works (try it, then learn the model), and License moves to the end of the meta cluster (after Acknowledgements). TOC updated to match. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 64 ++++++++++++++++++++++++++----------------------------- 1 file changed, 30 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 052c7f6..6ba8fed 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ - [What is AppleTrace?](#-what-is-appletrace) - [Key Features](#-key-features) -- [How It Works](#-how-it-works) - [Quick Start](#-quick-start) +- [How It Works](#-how-it-works) - [Installation](#-installation) - [Usage](#-usage) - [Processing & Visualizing Traces](#-processing--visualizing-traces) @@ -89,29 +89,6 @@ to explore the call timeline, durations, threads, and counters. --- -## ๐Ÿ”ง How It Works - -``` - Your app (instrumented) Host tooling Browser -โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” -โ”‚ APTBeginSection / APTEndโ€ฆ โ”‚ โ”‚ merge.py / โ”‚ โ”‚ โ”‚ -โ”‚ APTInstant / APTCounter โ”‚ โ”€โ”€โ”€โ–บ โ”‚ appletrace_cli.py โ”‚ โ”€โ”€โ”€โ–บ โ”‚ ui.perfetto.devโ”‚ -โ”‚ APTAsyncBegin / โ€ฆ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ -โ”‚ objc_msgSend auto-hook โ”‚ โ”‚ fragments โ†’ trace.jsonโ”‚ โ”‚ drag & drop โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ - per-thread batched writes X-complete collapse - โ†’ /Library/appletracedata โ†’ single JSON array -``` - -1. **Instrument** โ€” add manual markers, or install the `objc_msgSend` hook. -2. **Capture** โ€” events accumulate in per-thread buffers and flush in bulk to - trace fragments under `/Library/appletracedata`. -3. **Merge** โ€” pull the folder and run `merge.py`; begin/end pairs collapse into - Perfetto `X` complete events. -4. **Visualize** โ€” drag `trace.json` into Perfetto. - ---- - ## โšก Quick Start ```bash @@ -166,6 +143,29 @@ Open [ui.perfetto.dev](https://ui.perfetto.dev) and drag in `trace.json` (or use --- +## ๐Ÿ”ง How It Works + +``` + Your app (instrumented) Host tooling Browser +โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” +โ”‚ APTBeginSection / APTEndโ€ฆ โ”‚ โ”‚ merge.py / โ”‚ โ”‚ โ”‚ +โ”‚ APTInstant / APTCounter โ”‚ โ”€โ”€โ”€โ–บ โ”‚ appletrace_cli.py โ”‚ โ”€โ”€โ”€โ–บ โ”‚ ui.perfetto.devโ”‚ +โ”‚ APTAsyncBegin / โ€ฆ โ”‚ โ”‚ โ”‚ โ”‚ โ”‚ +โ”‚ objc_msgSend auto-hook โ”‚ โ”‚ fragments โ†’ trace.jsonโ”‚ โ”‚ drag & drop โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + per-thread batched writes X-complete collapse + โ†’ /Library/appletracedata โ†’ single JSON array +``` + +1. **Instrument** โ€” add manual markers, or install the `objc_msgSend` hook. +2. **Capture** โ€” events accumulate in per-thread buffers and flush in bulk to + trace fragments under `/Library/appletracedata`. +3. **Merge** โ€” pull the folder and run `merge.py`; begin/end pairs collapse into + Perfetto `X` complete events. +4. **Visualize** โ€” drag `trace.json` into Perfetto. + +--- + ## ๐Ÿ“ฆ Installation ### Requirements @@ -438,12 +438,6 @@ and the [Agent Guide](AGENT.md) for repository conventions. --- -## ๐Ÿ“œ License - -AppleTrace is released under the MIT License. See [LICENSE](LICENSE) for details. - ---- - ## ๐Ÿ™ Acknowledgements Inspired by Facebook's [fbtrace](https://github.com/facebookarchive/fbtrace), and @@ -452,6 +446,12 @@ built around Google's [Perfetto](https://perfetto.dev) and the --- +## ๐Ÿ“œ License + +AppleTrace is released under the MIT License. See [LICENSE](LICENSE) for details. + +--- + ## ๐Ÿ“ž Support
@@ -466,10 +466,6 @@ built around Google's [Perfetto](https://perfetto.dev) and the -**ไธญๆ–‡ไบคๆต๏ผš** ๆฌข่ฟŽๅ…ณๆณจๅพฎไฟก่ฎข้˜…ๅท - -WeChat - **Made with โค๏ธ by [Everett](https://github.com/everettjf)**