------------------
Compilation Notes:
------------------
	gcc or LLVM clang is required for compiling Mednafen.  Intel's C compiler may work, but is untested.
	Probably doesn't need to be said, but the compilers optionally specified via CC and CXX *must* be the same version.

	clang: 3.5.0 or newer is required, though gcc 4.9.x is preferable for performance reasons.

	gcc: 4.8(4.8.4+), or 4.9(4.9.2+) or newer is required.  gcc 4.9 is recommended; gcc 5.x and gcc 6.x tend to produce
	slower executables, at least with Mednafen on x86_64.

	Reportedly, passing:	--build=x86_64-apple-darwin`uname -r`
	to the configure script is necessary for building on Mac OS X to work properly.

	Compiling at -O3 or higher, or with other custom optimization flags, is discouraged.


---------------------------------------------
Some notes(and reminders) on the source code:
---------------------------------------------
	Check "mednafen/src/types.h" for standard C and C++ library header includes, and avoid #include'ing the same files redundantly elsewhere.

	Avoid %= in save state load variable sanitizing code unless the variable is unsigned.

	malloc(), realloc(), calloc()'ing 0 bytes of memory may return a NULL pointer.

	memcpy()/memmove()/etc. with NULL pointers is undefined and bad even when length is 0.

	Careful to not do something like: void somefunc(int something[16]); [...] sizeof(something)

	Try to avoid writing new code that violates strict overflow(even though we compile with -fwrapv), especially be mindful
	of stuff like what's described at http://kqueue.org/blog/2013/09/17/cltq/

	Order of operations != Operator precedence.  Remember sequence point rules, and don't do stuff like:
		value = FuncWithSideEffects() | (FuncWithSideEffects() << 8);	// BAD BAD
	See: http://en.cppreference.com/w/cpp/language/eval_order

	Avoid writing new code that shifts left signed integers or negative values to avoid technically undefined behavior; use
	ugly typecasting, or multiply by powers of 2 instead(remotely modern compilers can optimize it to a shift internally).

	Vanishing temporaries: https://gcc.gnu.org/onlinedocs/gcc/Temporaries.html#Temporaries

	Do not place a period before the field width for "s" and "[" conversion specifiers in *scanf() format strings; perhaps a bad
	habit picked up long ago from working with a buggy libc or trio?

	Avoid compiling different C++ files with different compiler flags in regards to instruction set used(like -mmmx, -msse, -mfpmath, -march),
	or else there may be (template-)function ODR violations that could cause compatibility problems.

	GPLv3-incompatible code:
		WonderSwan emulation code from Cygne.
		QuickLZ(old version used)

	Don't do greater-than and less-than comparisons between pointers unless they're pointers to members of the same array/struct/etc.

	Avoid using a pointer into a nested array of a multidimensional array to access elements of the multidimensional array that lie outside of that specific
	nested array, as such behavior is probably undefined.

	Pointer provenance, DR260.

	Don't create temporarily-invalid pointers via careless pointer arithmetic; restructure the expressions if possible, or utilize uintptr_t instead.

	x86_64 inline assembly, stack red zone.

	https://gcc.gnu.org/onlinedocs/gccint/Memory-model.html#Memory-model

	Don't use memcmp() on class/struct objects unless they're initialized with memset() and copied around with only memcpy()(or equivalent).

	Don't rely on malloc(), realloc(), and calloc() setting errno to ENOMEM on a memory allocation error.


---------------------------------------------
Code contributions:
---------------------------------------------
	To keep things simpler for commercial licensing, any patches or new code offered for emulation modules "apple2", "psx", "snes_faust", and "ss",
	along with contributions to core Mednafen functionality with code that is not self-contained(e.g. support for a new CD image format), will be ignored.
	Distributing a separate patch set or an outright fork(with branding that clearly conveys the forkiness) is recommended.

Mednafen's DOS port is NOT FINISHED YET RAWR!

Set "sound.volume" to "150" for moooostly better sound quality with 8-bit Sound Blaster cards.

Set "cd.image_memcache" to "1" to play CD games(requires a lot of RAM, though).

For EMU10K(SB Live, Audigy, Audigy 2):
	http://easymamecab.mameworld.info/html/snddosdr.htm
	http://sourceforge.net/projects/mpxplay/files/Audigy12/Audigy12%20v1.0/AUDIGY12.ZIP/download?use_mirror=tcpdiag&download=


Miscellaneous DOS-related notes.
---------------

DJGPP build notes:
 make am__cd="cd"

ES1370 and ES1371/ES1373/CT5880/EV1938 cards:
 Audio PCI 1000: ES1370

 Audio PCI 3000: ES1370

 Audio PCI 5000: ES1371
	Notes: Good frequency response with 48KHz playback.

 Audio PCI 5200: ES1373

 CT4700(Sound Blaster PCI 128): Creative 5507(rebranded ES1370?) - AK4531

 CT4730: EV1938
	Notes: Has questionable frequency response(too strong of a lowpass effect) on my card, and doesn't work
	completely correctly with Mednafen's ES1371 driver code.

 CT4740(Sound Blaster 16 PCI): CT5880
 CT4750(Sound Blaster Vibra128): CT5880
 CT4810: CT5880 - STAC 9721T or Creative CT1297-TAT or ???

 CT5800:
 CT5801:  - STAC972(or 3?)1T
 CT5803: ES1373
 CT5805: ES1373?
 CT5806: ES1373 - CS4297A-JQ
 CT5807: ES1373
 CT5808: CT5880
 CT5810:

 DCS S727: ES1370

eBay queries:
 (es1370,es1371,es1373,ct4700,ct4730,ct4740,ct4750,ct4810,"dcs s727", "audio pci 1000", "audio pci 3000", "audio pci 5000", "audio pci 5200")
 (ct5800,ct5801,ct5803,ct5805,ct5806,ct5807,ct5808,ct5810)

Refer to notes and scripts in the "mswin" directory.

--------------------------------------------------------------------------
Notes for building Mednafen's code outside of Mednafen's own build system:
    (though you should get most of this if you read configure.ac)

 Last updated November 28, 2014
--------------------------------------------------------------------------

gcc or LLVM(clang) is generally required, and ICC may work.  Other compilers will
require signficant changes to the codebase due to widespread usage of GNU extensions.

Compile with -fwrapv

Compile "ngp" module(Neo Geo Pop emulation) with -fno-strict-aliasing

Compile with -fomit-frame-pointer(at least on x86/x86_64).

Compile with -fsigned-char.

Compile with -fno-aggressive-loop-optimizations on newer versions of gcc that support it.

Compile in tests.cpp, and the call to the math test function, at least in your debug builds,
as it contains important compiler sanity checks.

Compile the PSX module with -mmmx -msse -msse2 on 32-bit x86 for better performance.

Compile with -fno-pic -fno-pie on 32-bit x86.

Define ARCH_X86(to 1) when compiling for 32-bit and 64-bit x86, and ARCH_X86_32 for 32-bit x86 and
ARCH_X86_64 for 64-bit x86_64.

Define ARCH_POWERPC and ARCH_POWERPC_ALTIVEC when compiling for POWER/PowerPC.

Do NOT compile with LTO, unless you use -fno-strict-aliasing(and that may negate the performance
benefits LTO provides).

Do NOT compile with -ffast-math, some relatively recent versions of gcc are buggy
and will produce completely wrong machine code for some common constructs
when -ffast-math is used.