This repo contains two projects: Demonchime and Teensy.

== Teensy ==

Teensy is a game engine/game framework built with Demonchime in mind. Its
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.

Additionally, Teensy is not designed to be dynamically linked. Rather, it is
designed to be a part of the codebase of the target application.

== 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
Demonchime. The working idea of Demonchime is that it's a combat-focused
metroidvania.

== Compiling ==

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:

$ make CONFIG=debug

If you want to immediately run the executable:

$ make run