From 45d950f721d05d55a865ac9eb1513c80c8bdf153 Mon Sep 17 00:00:00 2001 From: ry755 Date: Sun, 31 Jan 2021 19:33:47 -0800 Subject: [PATCH] Update README with info about framebuffer changes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 88ceb05..5ec4502 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ Texas Instruments TMS9918A VDP emulator library for Rust ![TMS9918A](https://upload.wikimedia.org/wikipedia/commons/d/de/TMS9918A_02.jpg) -tms9918a_emu uses the [minifb](https://github.com/emoon/rust_minifb) crate to emulate a [Texas Instruments TMS9918A](https://en.wikipedia.org/wiki/Texas_Instruments_TMS9918) video display processor in a window. +tms9918a_emu emulates a [Texas Instruments TMS9918A](https://en.wikipedia.org/wiki/Texas_Instruments_TMS9918) video display processor and provides a basic framebuffer as `Vec` which can be used with other creates, such as [minifb](https://github.com/emoon/rust_minifb), to create a window. High-level functions are provided as well as low-level functions, making it easy to control the VDP without needing to use the control and data ports. This emulator is a work-in-progress and currently only supports the Graphics I and Text video modes, and sprites are unsupported in all modes. In its current state, this emulator is more of a TMS9918 (non-A variant) emulator. ## Example -This is a small [example program](examples/high_level_text/src/main.rs) which uses Text mode to display a hello world message, showing how to use the high-level functions: +This is a small [example program](examples/high_level_text/src/main.rs) which uses Text mode to display a hello world message in a minifb window, showing how to use the high-level functions: ![High-level Text mode example](examples/high_level_text/images/screenshot.png) A similar [example program](examples/low_level_text/src/main.rs) is available which shows how to use the low-level functions to display the same hello world message.