book README

The project's README from github.com/astrid-runtime/book. As one markdown file: README.md.

The Astrid Book

The canonical reference for Astrid: the kernel, the capsule model, the host ABI, the bus, and the security model.

Built with mdBook.

mdbook serve --open

The reference appendices (capability catalog, host ABI error codes, topic registry) are generated from the Astrid source by tools/gen-appendices.sh. The cross-chapter "See also" footers are generated by tools/gen-see-also.pl. Both read the polyrepo source tree, so run them from a checkout that has core/, wit/, and capsules/ as siblings.

Dual-licensed under MIT and Apache 2.0.

Copyright (c) 2025-2026 Joshua J. Bouw and Unicity Labs.

book (astrid-runtime/book)

Searching Database…

7.5K ·GitHub
这是什么?这是 Astrid 的官方参考手册,涵盖其内核、胶囊模型、宿主 ABI、IPC 总线和安全模型。
这是 Astrid 本身,还是只是文档?这是一本使用 mdBook 构建的静态文档手册,而不是运行时软件;它描述 Astrid,但并不运行 Astrid。
我该如何构建这本手册?将本仓库与 Astrid 多仓库中的 core/、wit/ 和 capsules/ 仓库并列检出,运行附录生成脚本,然后使用 mdBook 构建。
构建这本手册还需要 Astrid 的其他源代码吗?需要。附录由 tools/gen-appendices.sh 生成,跨章节链接由 tools/gen-see-also.pl 生成,这两个脚本都会读取完整的多仓库源代码。
我能只检出这一个仓库来构建吗?不能。要构建完全准确的副本,需要同时检出 core/、wit/ 和 capsules/ 仓库,因为生成脚本会跨仓库读取它们。
生成的能力目录附录包含什么内容?它由 tools/gen-appendices.sh 生成,包含能力目录、宿主 ABI 错误码以及直接从 Astrid 源代码中提取的主题注册表。
为什么要用 Perl 脚本处理跨章节链接?tools/gen-see-also.pl 会扫描多仓库源代码,自动生成“另请参阅”页脚,用于连接全书中相关的章节。
Size
0.3 MB
Stars
7.5K
Updated
CommitSep 08
Age
4mo
Commits · 90 Days