mirror of
https://github.com/seekrs/MacroLibX.git
synced 2026-01-11 14:43:34 +00:00
working on readme
This commit is contained in:
14
README.md
14
README.md
@@ -1,15 +1,11 @@
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/420verfl0w/MacroLibX/master/res/logo.png" alt="drawing" width="400"/>
|
||||
</p>
|
||||
|
||||
# MacroLibX [![linux clang workflow][linux-clang_badge]][linux-clang_wf] [![linux gcc workflow][linux-gcc_badge]][linux-gcc_wf] [![macos workflow][macos_badge]][macos_wf]
|
||||
###### A rewrite of 42 School's MiniLibX using SDL2 and Vulkan.
|
||||
|
||||
The goal of this version is to provide a light, fast, and modern graphical tool while keeping the same API.
|
||||
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/420verfl0w/MacroLibX/master/res/screenshot_test.png" alt="drawing" width="400"/>
|
||||
<img src="./res/logo.png" alt="drawing" width="200"/>
|
||||
</p>
|
||||
The goal of this version is to provide a light, fast, and modern graphical tool while keeping the same API.
|
||||
|
||||
## 🖥️ Installation
|
||||
|
||||
@@ -68,6 +64,12 @@ To compile your project with MacroLibX, you just provide the shared library path
|
||||
clang myApp.c /path/to/MacroLibX/libmlx.so -lSDL2
|
||||
```
|
||||
|
||||
And you can enjoy your project
|
||||
|
||||
<p align="center">
|
||||
<img src="./res/screenshot_test.png" alt="drawing" width="400"/>
|
||||
</p>
|
||||
|
||||
### ⚠️ Troubleshooting
|
||||
|
||||
#### If you run into glitches when writing or reading pixels from images
|
||||
|
||||
Reference in New Issue
Block a user