From 3ea2a85a9427f1faccb1a13c9c40e648dd5023a5 Mon Sep 17 00:00:00 2001 From: light7734 Date: Fri, 11 Jul 2025 12:53:07 +0330 Subject: [PATCH] docs: update repository README --- README.md | 37 +------------------------------------ 1 file changed, 1 insertion(+), 36 deletions(-) diff --git a/README.md b/README.md index 0e6ba86..5ce076d 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,2 @@ # Light -~~A Cross-Platform, Cross-GraphicsAPI Game Engine~~ - -A game engine with Vulkan backend and emphasis on pixel art. - -## New plan -I'm going to remove the support for DirectX & OpenGL, this engine will only implement Vulkan for performance and simplicity(not Vulkan's simplicity but simplicity of not having 3 GraphicsAPIs exposed using the same functions...) - -But for the time being, I need to learn vulkan, so the engine will be in an unusable state - -Many things need to be changed as well, and I do have a busy schedule, so it'll take a while. - -## Supported Operating Systems -* Linux -* Windows (Fails to build ATM) - -Will support: -* Mac - -## Getting Started - -### Prerequisites -* CMake (duh) -* C++ 20 -* Vulkan 1.3 support - -### Getting the project -```bash - git clone --recurse-submodules https://github.com/Light7734/light - # if you cloned non-recursively then run "git submodule update --init" - mkdir light/build - cd light/build - cmake -DEXPORT_COMPILE_COMMANDS=1 .. && ln -fs ./compile_commands.json ../compile_commands.json - cmake --build . -j20 -``` - -hmu if you wanna chat Light7734#4652 +See docs.light7734.com for a comprehensive project documentation