project-ely/README.md

898 B

Project Ely

This is some game project that we are working on for fun.

This project is written in Go using SDL2.

Compiling

See the Setup Docs for installing all the necessary dependencies. It's fairly bare-bones, only requiring SDL.

Then you can use the Makefile:

make release

Or you can build the project easily with Go directly:

go build

A release build can be build with these extra flags:

go build -x -v -ldflags "-s -w"

Running

You may need the SDL2 libraries in order to run the resulting binary. Copy the SDL2 *.dll or *.so files into the same directory as the output executable and run the program.

Docs

For initial environment setup, see the Setup Docs.

License

This project is licensed under the 2-Clause BSD license, a permissive open-source license. See LICENSE.md for more details.