docs : add README

2025-05-15 16:38:09 +09:00
parent 3c35bc7fea
commit 010cbb4161
1 changed files with 20 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,20 @@
+# UEFI-Video
+Media renderer embedded in UEFI boot environment
+
+## Features
+- Render GIF
+- Render PNG
+
+## Requirements
+- Rust toolchain
+- Appropriate rust target
+
+## Build
+```bash
+cargo build --target x86_64-unknown-uefi --release
+# result: uefi-video.efi
+```
+
+## Test Info
+Tested on:
+- `x86_64-unknown-uefi`