diff --git a/README.md b/README.md index 9dcb94d..fddf639 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ # CrScreenshotDxe UEFI DXE driver to take screenshots from GOP-compatible graphic console -Written for [this post](http://habrahabr.ru/post/274463/), proper description and usage in English will be added a bit later. +[This blog post in Russian](http://habrahabr.ru/post/274463/) explains more, here is just a description and usage. + +## Description +This DXE driver tries to register keyboard shortcut (LCtrl + LAlt + F12) handler for all text input devices. The handler tries to find a writable FS, enumerates all GOP-copable video devices, takes screenshots from them and saves the result as PNG file on that writable FS. + +The main goal is to be able to make BIOS Setup screenshots for systems without serial console redirection support, but it can also be used to take screenshot from UEFI shell apps and UEFI bootloaders. + +To start the driver, you can either: +- Integrate it into DXE volume of your UEFI firmware using [UEFITool](https://github.com/LongSoft/UEFITool) or any other suitable software +- Add it to an OptionROM of a PCIe device (will try it once I have a device needed) +- Let BDS dispatcher load it by copying it to ESP and creating a DriverXXXX variable +- Load it from UEFI Shell with load command + +## Build +It's a normal EDK2-compatible DXE driver, just add it to your package's DSC file to include in it's build process. + +## Usage +Load the driver, insert FAT32-formatted USB drive and press LCtrl + LAlt + F12 to take a screenshot from all GOP-compatible graphic consoles available at the moment. + +To indicate it's status, the driver shows a small colored square in top-left corner of the screen for half a second. + +Square color codes: +- White, driver is loaded +- Yellow, no writable FS found, screenshot is not taken +- Blue, current GOP is pitch black, screenshot is not taken +- Red, something went wrong, screenshot is not taken +- Green, screnshot taken and saved to PNG file