head	1.3;
access;
symbols;
locks; strict;
comment	@# @;


1.3
date	93.06.28.03.05.47;	author pjs;	state Exp;
branches;
next	1.2;

1.2
date	93.06.28.01.27.02;	author pjs;	state Exp;
branches;
next	1.1;

1.1
date	93.06.26.18.42.40;	author pjs;	state Exp;
branches;
next	;


desc
@@


1.3
log
@*** empty log message ***
@
text
@This directory contains the start of my API for WABI for Linux.
This software is distributed under the terms outlined in the
GNU Public License. See COPYING for more information.

NOTE!!!!!
	Do not use the Minix Filesystem with this distribution since
	many of the filenames are longer than 14 characters.

Currently, everything is simply stubbed out and needs to be
filled in. I have tried to maintain the variable declaration
conventions as defined in the Windows Programmer's Reference.
Although, I personally find this style awful, I believe it
makes more sense to keep with the conventions setup by Microsoft,
or should I say Apple :-)

There are two books that are a must to have if you plan to
extend any of this:

	Windows Programmer's Reference
	Microsoft Press
	ISBN 1-55615-309-0

	Undocumented Windows
	Andrew Schulman, et al
	Addison-Wesley
	ISBN 0-201-60834-0

This directory is broken down into four subdirectories:

	bin	- contains binaries built by make
	   objs	  - contains object files and dependency files
	   libs   - contains final libraries
	h	- contains header files
	   gdi    - private headers for gdi library
	   kernel - private headers for kernel library
	   user   - private headers for user library
	src	- contains source for each of the DLLs
	   kernel - contains source for kernel.exe
	   user   - contains source for user.exe
	   gdi    - contains source for gdi.exe
	make	- contains make rules

Before trying to compile anything you must set the enviroment
variable WABI_ROOTDIR. This variable should point to the directory
that contains this README. For instance, I have it set to:

	export WABI_ROOTDIR=/usr/local/src/wabi/DLL

since the bin, h, src, and make subdirectories reside in
/usr/local/src/wabi/DLL.

Here are few things concerning the make rules:
	1. if NO_DEPEND is defined then dependencies will not
		be included (or created). This is useful when
		initially creating and modifying the headers.
	2. By default the rules turn on -Werror. To turn them
		off for a specific file, add a line like:
			WERROR_foo.c=FALSE

If you make changes to any of the code, please send me patches.
Also please try to maintain the interface as is defined in
the Windows Programmer's Reference (i.e. same capitalization
and variable names). Also, if you add new modules (e.g. sound.drv)
make a new directory under src (e.g. sound). Also if you
add anything to windows.h try to break it out as best you can (e.g.
windows.h includes bitmap.h which defines the bitmap structure
and stuff). This helps when multiple people are working on the
same piece of code (also eventually the source should only include
those pieces it needs. For instance, CreateBitmap would include
bitmap.h and windows.h. Eventually, windows.h will not include
everything. This stops everthing from recompiling when you make
a simple change to bitmap.h).

Happy Hacking.
-pat
pjs@@kodak.com
@


1.2
log
@*** empty log message ***
@
text
@d52 8
@


1.1
log
@Initial revision
@
text
@d10 4
a13 8
filled in. The only subdirectory that is completely stubbed out
correctly is the kernel; the user and gdi subdirectories are also
stubbed out, but the parameters are missing and the function
names are not capitalized properly. In the kernel (and in the near
future for user and gdi) I have tried to maintain the variable
declaration conventions as defined in the Windows Programmer's
Reference. Although, I personally find this style awful, I believe
it makes more sense to keep with the conventions setup by Microsoft,
d34 3
d64 1
a64 1
a simple change to bitmap.h.
@
