light7734/light
light7734/light
1
1
Fork 0
Code Issues 19 Pull requests 3 Projects 1 Releases Packages Wiki Activity

docs: update repository README

Browse source
This commit is contained in:
light7734 2025-07-11 12:53:07 +03:30
parent 29e9033c0c
commit 3ea2a85a94
Signed by: light7734
GPG key ID: 8C30176798F1A6BA
1 changed files with 1 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -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