-
Notifications
You must be signed in to change notification settings - Fork 38
Build Guide
When creating builds, there are a few things to keep in mind.
For Windows builds, build 32 bit for broader compatibility, for Mac OS, build Universal builds, and for Linux, use the option to build both 64 and 32 bit versions.
All builds should be compressed into archives (generally .zip for Mac and Windows, .tar.gz for Linux). These archives should use the same naming pattern as the builds themselves, but with a -platform suffix: bad-golf-ce_YYYY_MM_DD-XXXXXXX
For example: bad-golf-ce_2014_02_17-b01a8c5-windows.zip
Development builds should be named according to ISO date and the Git short revision that they're based on, using the pattern: bad-golf-ce_YYYY_MM_DD-XXXXXXX
To get the short git revision, use the git rev-parse command with the --short argument. For example, to get the short revision of the current head, using the following command: git rev-parse --short HEAD
Here's an example build name: bad-golf-ce_2014_02_17-b01a8c5
We haven't yet decided on a release build naming scheme, but it's likely to look something like: bad-golf-ce_1.0_clever-title-here
For security reasons, Mac OS and Linux file systems require files to have 'executable permissions' before they can be run. These can not be easily set from Windows.
The following command will set the executable permission on the Linux binaries (adjust file name as appropriate): chmod +x bad-golf-ce_2014-02-17_b01a8c5*
The following command will set executable permission on the Mac OS binary (adjust .app folder name as appropriate): chmod +x bad-golf-ce_2014-02-17_b01a8c5.app/Contents/MacOS/BadGolf2