home: hub: zuo

Info  •  Files  •  Log

add README and docs note about the `--image` flag for `local/image.zuo`

--- a/README.md

+++ b/README.md

@@ -82,7 +82,9 @@

 You can use heap images without embedding. The `dump-heap-and-exit`

 Zuo kernel permitive creates a heap image, and a `-B` or `--boot`

-command-line flag for Zuo uses the given boot image on startup.

+command-line flag for Zuo uses the given boot image on startup. You

+can also embed an image created with `dump-image-and-exit` by using

+`local/image.zuo` with the `--image` flag.

 A boot image is machine-independent, whether in a stand-alone file or

 embedded in `.c` source.

@@ -115,4 +117,4 @@

 Install the `zuo-doc` directory as a package in Racket to render the

 documentation there, or see

-[doc.racket-lang.org](https://docs.racket-lang.org/zuo/index.html).

+[docs.racket-lang.org](https://docs.racket-lang.org/zuo/index.html).

--- a/zuo-doc/overview.scrbl

+++ b/zuo-doc/overview.scrbl

@@ -106,7 +106,9 @@

 You can use images without embedding. The @racket[dump-image-and-exit]

 Zuo kernel permitive creates an image containing all loaded modules,

 and a @Flag{B} or @DFlag{boot} command-line flag for Zuo uses the

-given boot image on startup.

+given boot image on startup. You can also embed an image created with

+@racket[dump-image-and-exit] by using @filepath{local/image.zuo} with

+the @DFlag{image} flag.

 A boot image is machine-independent, whether in a stand-alone file or

 embedded in @filepath{.c} source.