diff options
| -rw-r--r-- | README | 46 |
1 files changed, 37 insertions, 9 deletions
@@ -1,9 +1,19 @@ This repo contains two projects: Demonchime and Teensy. +== Teensy == + Teensy is a game engine/game framework built with Demonchime in mind. Its -primary features are a software renderer and a platform abstraction. With these -two features, the game should be able to be ported to basically any platform I -want it to run on, just so long as it meets the minimum specs. +features include: + +- A software renderer +- A platform abstraction +- An immediate-mode GUI library + +Teensy should be at least somewhat portable to whatever systems meet the +minimum specs, although currently the only targets are common operating +systems. + +== Demonchime == Demonchime is a game that I'm still working out the details of. It is currently not in development as Teensy is not at a stage where it can be used to make @@ -12,12 +22,30 @@ metroidvania. == Compiling == -Currently only compiles on Linux. You may be able to get it to compile on -Windows with some effort. +Currently only compiles on Linux. It is possible to compile it on Windows with +some effort, but it is not currently supported. MacOS is not, and will never be +officially supported. + +To build: + +First install GLFW via your system package manager, or set the relevant +environment variables to point the compiler towards your installation. + +Then, run these commands in the root directory of the repo: + +$ cp config.def.mk config.mk +$ make + +It will output an executable called `demonchime', which you can then run. If +desired, most compilation flags can be customized via config.mk + +== Development == + +If you need to use a debugger or otherwise inspect the executable, you can +enable debug flags: -To build, first compile GLFW. -Then, run this in the root directory of the project: +$ make CONFIG=debug -$ ./build.sh +If you want to immediately run the executable: -It will output an executable called `demonchime'. +$ make run |