Module bundle

Module bundle 

Source
Expand description

cargo xtask bundle — package a KoboRoot.tgz for device installation.

Creates one or more .tgz archives that can be placed in the .kobo/ directory on a Kobo device to install or update Cadmus.

§Output files

FlagOutputContents
(default)bundle/KoboRoot-nm.tgzCadmus + NickelMenu
--no-nickelbundle/KoboRoot.tgzCadmus only
--testbundle/KoboRoot-nm-test.tgzTest build + NickelMenu
--test --no-nickelbundle/KoboRoot-test.tgzTest build only

§NickelMenu

NickelMenu is downloaded from GitHub Releases and cached in .cache/nickelmenu/. The version is controlled by NICKEL_VERSION. Pass --skip-download to use a previously cached archive.

Structs§

BundleArgs
Arguments for cargo xtask bundle.

Constants§

NICKEL_VERSION
The NickelMenu release version to bundle.

Functions§

create_bundle_cadmus_only 🔒
Creates a bundle containing only Cadmus (no NickelMenu).
create_bundle_with_nickel 🔒
Creates a bundle that merges Cadmus with NickelMenu.
download_nickel_menu 🔒
Downloads the NickelMenu release archive from GitHub with checksum verification.
ensure_nickel_menu 🔒
Returns the path to the NickelMenu archive, downloading it if necessary.
run
Packages the distribution directory into a KoboRoot.tgz.