Copyright 1995-2023 by Rebecca Ann Heineman becky@burgerbecky.com. Email all suggestions, corrections, optimizations and insults to her and she'll be eternally grateful.
It is released under an MIT Open Source license. Please see LICENSE for license details. Yes, you can use it in a commercial title without paying anything, just give me a credit.
Please? It's not like I'm asking you for money!
Yes, click the link above. DO IT! BOOKMARK IT!
To build documentation locally, in the docs
folder, type "buildme -docs
". Make sure that doxygen
, dot
, and pandoc
are in the path. The HTML documentation will be found in docs/temp/burgerlibdoxygen/index.htm
Python can be downloaded here.
After Python is installed, run pip install -r requirements.txt
from the root folder. This will ensure buildme
and other python scripts needed by the build system are present.
Once it is installed, run buildme
to build everything in the root or projects folders, or buildme whatever.sln
to build a specific project file. buildme
will build all project files. cleanme
will clean a folder of all temporary files.
To build with Open Watcom, download and install the compiler and set the environment variable WATCOM
to point to the installation folder, usually C:\WATCOM
SHA-1 236ac33ebd463006be4ecd83d7ebea1c026eb55a
To build with Metrowerks Codewarrior, download and install the compiler. To install, first run CW_Windows_9.2.exe
and then install CW_Windows_9.4_Update.exe
. After installation, copy the file license.dat
over the file C:\Program Files (x86)\Metrowerks\CodeWarrior\license.dat to update the license to a permanent one.
Download Codewarrior 9.4 for Windows here
SHA-1 2a8a839aa34a0e7b8400004788f0cbc3db03f90e for CW_Windows_9.2.exe
SHA-1 6da8be8022bf96b9387b6b14980944092ed2fc46 for CW_Windows_9.4_Update.exe
Download Visual Studio at Visual Studio website. Visual Studio 2022 is recommended, however versions from 2003, 2005, all the way to 2022 is supported.
Download these three ISO files,
Download Visual Studio code here
Download Doxygen for the host platform from here.
This is needed to build Burgerlib Windows using older compilers.
Download DirectX 9.0c SDK June 2010 here
SHA-1 495ad05ae5fc4ecd76b53a69a35bacb66d958608
Needed for Windows builds.
- \ref page_what_is_burgerlib
- \ref page_building
- \ref page_using_burgerlib
- \ref page_compiler_issues
- \ref page_defines
- \ref page_platform_types
- \ref page_white_papers
- Rebecca Ann Heineman - most of the codebase
- Gary S. Brown - CRC32B
- Jean-loup Gailly - Original Zlib compressor
- Mark Adler - Original Zlib decompressor
- Thatcher Ulrich - Hash template
- Daniel Julius Bernstein - djb2 hash algorithm
- Matt Pritchard - SafePrint