From 2a6feb40045225bcccdb163ff6c51643059230d7 Mon Sep 17 00:00:00 2001 From: KG <41345727+kg583@users.noreply.github.com> Date: Fri, 29 Dec 2023 01:13:28 -0500 Subject: [PATCH] Add section about flash files --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12ef42e..131ae0a 100644 --- a/README.md +++ b/README.md @@ -210,13 +210,20 @@ my_program.raw.archived = b'\x80' assert my_program.raw.type_id == b'\x05' ``` -> [!CAUTION] +> [!WARNING] > Edits to read-only bytes like the checksum are reset whenever any other data in the var is updated. ### Models All TI-82/83/84 series calcs are represented as `TIModel` objects stored in `tivars.models`. Each model contains its name, metadata, and features; use `has` on a `TIFeature` to check that a model has a given a feature. Models are also used to determine var file extensions and token sheets. +### Flash Files + +Flash files such as apps, OSes, and certificates can be loaded using the `TIFlashHeader` base class or its children. A flash file is composed of one to three headers (though usually only one); these are not to be confused with var headers. A flash header does _not_ need to be "packaged" into a larger file format like an entry in a regular var; see `TIFlashHeader.open` and `TIFlashHeader.save`. + +> [!TIP] +> Loading flash files into a `TIEntry` probably won't work very well. + ## Other Functionalities ### PIL