This source code archive contains code for Enterprise, a custom UEFI bootloader. It is designed to compliment Mac Linux USB Loader, though it can also be used separately (albeit with some setup work). The purpose of Enterprise is as the first stage in a three-stage booting process for Mac Linux USB Loader-created USB drives. Essentially, Enterprise loads GRUB, giving it a configuration file with things that it needs to successfully boot the Linux distribution on Mac hardware. This is a paradigm shift from my current solution, a pre-compiled GRUB executable with an embedded configuration file, which is outdated, inflexible, and, due to differences in how distributions pack their ISOs, largely unable to boot anything other than Ubuntu derivatives.
Now, with that out the way (phew!), let's get to the interesting stuff, shall we?
Enterprise is under the LGPL. Enterprise is not only my program; it pulls in code from other software projects (namely, gummiboot), and I want to make sure that not only they get credit from their work, but that others can benefit from what I've done as well. Releasing Enterprise under the LGPL allows me to most easily do this.
I've decided to establish, up front, a coding style for Enterprise for anyone that wants to contribute. Most important: braces and if-statements. I'll sum up my policy in one code block:
if (true)
bob();
else
sam();
is not complaint. This is how I prefer it:
if (true) {
bob();
} else {
sam();
}
For those of you in the know, I code using a style called 1TBS - or, the "one true brace style". I quite like it. So much so, in fact, that it's the required syntax style (just so things don't get messy).
Same goes with functions, other blocks like while, do, and pretty much anything else. Please realize that not everything will be under this style (particularly code I've pulled in from elsewhere), but I'll do my best to follow this style, and if you contribute, I expect you to do yours.
Secondly, all source code files must use tabs - not spaces, and I expect a tab width of 4. If your editor is configured to use spaces, you must convert the spaces into tabs with a width of 4. This can be done with a UNIX command like unexpand --tabs=4.
I will accept pull requests on two conditions:
- Your code follows my coding styles (mentioned above) and
- Your code is licensed under an LGPL-compatible license and is readable and decently commented.
Assuming that your code is in compliance with these rules, I usually will accept pull requests that either: add a feature/fix a bug that is listed via the checkboxes above or fix an issue filed through GitHub.
That's about it, I think. Hope this helps someone.