Updated readme
This commit is contained in:
parent
6ecbdb56d5
commit
375ca2e372
1 changed files with 23 additions and 9 deletions
32
README.md
32
README.md
|
@ -1,14 +1,20 @@
|
|||
# SLK Engine
|
||||
|
||||
A software accelerated engine using OpenGL to bring the graphics on the screen.
|
||||
It's made for low resolutions (eg. 256x240), but can be used for higher resolutions, too.
|
||||
A software accelerated engine that uses OpenGL to bring the graphics to the screen. It's made for low resolutions (eg. 256x240), but can be used for higher resolutions, too.
|
||||
|
||||
## Features
|
||||
|
||||
* Layers: Draw to multiple independent layers
|
||||
* RGB drawing: Draw in 32bit rgba colorspace
|
||||
* Pal drawing: Draw in palletized 8bit colorspace and change the palette on the fly, without needing to redraw
|
||||
* Image loading: Load and save from and to multiple file formats
|
||||
* OpenGL 2.1: It's old. It's antiquated. I mean, who needs shaders anyway?
|
||||
|
||||
## License
|
||||
|
||||
SLK is released under the zlib license, see LICENSE.md for details.
|
||||
Some of the examples may be released under a different license though.
|
||||
SLK is free Software (as in freedom) and is released under the zlib license, see LICENSE.md for details. Most of the examples are released under the same license, unless noted otherwise of course.
|
||||
|
||||
## Using the engine
|
||||
## Using SLK
|
||||
|
||||
To use SLK you need to have the following libraries installed:
|
||||
|
||||
|
@ -16,11 +22,19 @@ To use SLK you need to have the following libraries installed:
|
|||
|
||||
You need to link your programm to the following libraries:
|
||||
|
||||
* Opengl
|
||||
* SDL 2
|
||||
Linux:
|
||||
|
||||
* -lSDL2
|
||||
* -lGL
|
||||
* -ldl
|
||||
|
||||
## Plattforms
|
||||
|
||||
SLK has been tested on the following plattforms/os:
|
||||
SLK has been tested and is working on the following plattforms/os:
|
||||
|
||||
* Linux
|
||||
* Void GNU/Linux, amd64: [Enter the void](https://voidlinux.org/)
|
||||
|
||||
## Library Credits
|
||||
|
||||
* [stb_image](https://github.com/nothings/stb/blob/master/stb_image.h)
|
||||
* [stb_image_write](https://github.com/nothings/stb/blob/master/stb_image_write.h)
|
||||
|
|
Loading…
Reference in a new issue