From e114123df2a05650f0f7e34044c1e8f829c50a44 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 3 Mar 2025 16:43:19 +0100 Subject: misc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..7c9c913 --- /dev/null +++ b/README @@ -0,0 +1,50 @@ +NAME + liblss16 - Library for the SYSLINUX "ad hoc" LSS16 image format + +DESCRIPTION + liblss16 is a C library for encoding and decode the LSS16 image file + format, which is a SYSLINUX "ad hoc" lossless, compressed, low-fidelity + image file format optimised bootloaders in low-end graphics + environments. + + liblss16 provides the following functions for decoding LSS16 images: + + liblss16_decoder_init(3) + Prepare state for liblss16_decode_to_colour_index(3). + + liblss16_decode_to_colour_index(3) + Decode an file. The colour of each pixel is output with + the index of the colour in the colour palette. + + liblss16_decode_strerror(3) + Get error description for error code returned by + liblss16_decode_to_colour_index(3). + + liblss16 provides the following functions for encoding LSS16 images: + + liblss16_optimise(3) + Optimise an image for optimal compression with LSS16. + + liblss16_encoder_init(3) + Prepare state for liblss16_encode_from_colour_index(3). + + liblss16_encode_from_colour_index(3) + Encode an file. The colour of each pixle is input as the + index of the colour in the colour palette. + + liblss16_encode_strerror(3) + Get error description for error code returned by + liblss16_encoder_init(3) or + liblss16_encode_from_colour_index(3). + +EXTENDED DESCRIPTION + The liblss16 project also implements the following utilities: + + lss16toppm(1) + Convert an LSS16 file to a Portable Pixmap (PPM) file. + + ppmtolss16(1) + Convert a Portable Anymap (PNM) file to an LSS16 file. + +SEE ALSO + lss16(5), syslinux(1) -- cgit v1.2.3-70-g09d2