added README
This commit is contained in:
parent
eb519bdf93
commit
020d3b8de1
|
@ -0,0 +1,41 @@
|
|||
SFW (SDL Framework)
|
||||
===================
|
||||
|
||||
SFW is a library of C++ objects that facilitate the creation of SDL projects.
|
||||
It is modeled after PGFW, a Pygame framework, which is an older project of mine.
|
||||
It is currently in an early untested stage, but it comes with a simple program
|
||||
that demonstrates how the framework can help set up a project in both SDL and
|
||||
OpenGL contexts.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
The SFW source comes with a few libraries in the lib/ folder, but there are
|
||||
other libraries that must be present in order to compile a project which uses
|
||||
the framework
|
||||
|
||||
- libSDL2 (developed with 2.0.9)
|
||||
- libSDL2-image
|
||||
- libSDL2-ttf
|
||||
- libSDL2-mixer
|
||||
- Open GL
|
||||
- compiler that supports C++17
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
The demo/ folder contains a simple cube demo. The main purpose of the demo is
|
||||
to demonstrate switching between 3D and 2D contexts. In order to compile the
|
||||
demo, you will have to edit the paths in the Makefile to point to the locations
|
||||
of the necessary libraries on your system.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
This software is dedicated to the public domain. See
|
||||
http://creativecommons.org/publicdomain/zero/1.0/ for details.
|
||||
|
||||
Contact
|
||||
-------
|
||||
|
||||
You can email me at frank at shampoo.ooo
|
Loading…
Reference in New Issue