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, которое описывает его ядро, модель капсул, host ABI, шину IPC и модель безопасности.
Это сам Astrid или только документация?Это статическая документация, собранная с помощью mdBook, а не программа. Она описывает Astrid, но сама его не запускает.
Как собрать эту книгу?Склонируйте репозиторий рядом с репозиториями core/, wit/ и capsules/ из набора репозиториев Astrid, запустите скрипты генерации приложений, а затем соберите книгу с помощью mdBook.
Нужен ли остальной исходный код Astrid, чтобы это собрать?Да. Приложения генерирует tools/gen-appendices.sh, а перекрёстные ссылки между главами — tools/gen-see-also.pl. Оба скрипта читают весь исходный код набора репозиториев.
Можно ли собрать книгу из одного этого репозитория?Нет. Для полностью точной сборки нужны репозитории core/, wit/ и capsules/, склонированные рядом с этим, так как скрипты генерации читают код из них.
Что входит в сгенерированное приложение с каталогом возможностей?Его создаёт tools/gen-appendices.sh. Оно включает каталог возможностей, коды ошибок host ABI и реестр топиков, взятые прямо из исходного кода Astrid.
Зачем перекрёстные ссылки между главами обрабатывает скрипт на Perl?tools/gen-see-also.pl сканирует исходный код набора репозиториев и автоматически создаёт блоки «См. также» внизу глав, которые связывают между собой близкие разделы книги.
Size
0.3 MB
Stars
7.5K
Updated
CommitSep 08
Age
4mo
Commits · 90 Days