Sean Hickey f8d47107ce | ||
---|---|---|
.vscode | ||
assets | ||
docs | ||
internal | ||
scripts | ||
.gitignore | ||
Dockerfile | ||
LICENSE.md | ||
Makefile | ||
README.md | ||
go.mod | ||
go.sum | ||
main.go |
README.md
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.
Licenses
Unless otherwise specified, the code for this project is licensed under the 2-Clause BSD license, a permissive open-source license. The short version is that you may use this code for any purpose so long as you give us credit for creating it. See LICENSE.md for more details.
Unless otherwise specified, the artwork assets and documentation (the non-code related things) for this project are licensed under the Creative Commons Attribution 4.0 International Public License. The short version is that you may use them for any purpose so long as you give us credit for creating them. See assets/LICENSE.md for more details and assets/legalcode.txt for the full license text.
Basically, so long as you give us credit for creating this game, you may use any parts of it for any purpose.