diff --git a/README.md b/README.md new file mode 100644 index 0000000..ae9650d --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# VK Cube + +This program renders a simple colored 3d cube using the Vulkan API. +Only linux with XCB and Wayland is supported. + +![Screenshot](assets/app_screenshot.png) + +## Building + +```bash +git clone +cd vk_cube +# ALPINE: apk add --no-cache vulkan-loader-dev libdrm-dev libpng-dev ninja-build meson +# UBUNTU: sudo apt-get install libvulkan-dev libdrm-dev libpng-dev ninja-build +# on ubuntu meson must be installed from pip + +# Customize the meson build type here (release, debug, debugoptimized, etc.) +meson setup builddir --buildtype=release +meson compile -C builddir +``` diff --git a/assets/app_screenshot.png b/assets/app_screenshot.png new file mode 100644 index 0000000..9388a54 Binary files /dev/null and b/assets/app_screenshot.png differ