diff --git a/README.md b/README.md index 56dd28c..c9d287c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ -# pbio: simple pixel buffer I/O +# pbio: simple pixel buffer and I/O system -Pixelbuffer-basiertes Fenster mit Palette-Lookup-Renderer (GLFW + wgpu). +Pixelbuffer-basiertes Fenster mit Palette-Lookup-Renderer (GLFW + wgpu) und Maus/Tastatureingaben. pbio nimmt einen Bytearray, interpretiert diesen als 8-Bit-Pixelbuffer und rendert ihn auf ein Fenster. Optional mit Letterbox für ein festes Seitenverhältnis +## Integration + +pbio ist nicht auf crates.io veröffentlicht. Das Crate kann direkt aus dem Git-Repository eingebunden werden: + +```toml +[dependencies] +pbio = { git = "https://codeberg.org/irrlicht/rust-pbio.git" } +``` + +pbio benötigt eine funktionierende GLFW-Toolchain (CMake + C-Compiler) zum Bauen sowie aktuelle Grafiktreiber mit Vulkan-, Metal- oder DX12-Unterstützung für wgpu. + ## Verwendung ```rust