[xbuild] Function names are case insensitive.

[mono.git] / eglib / README

diff --git a/eglib/README b/eglib/README
index 03849b5fdca4ee7e321ce18e761f16ba93f86fc6..eea89f520a8649eb38856bbc36619b93f31408ff 100644 (file)
--- a/eglib/README
+++ b/eglib/README
@@ -15,21 +15,25 @@ Currently all the definitions go into a single file: glib.h, there are
 no separate files, please try to follow the convetions in the source code
 
 * Tests
+       
+       Please read the README in tests/
 
-       Please run the tests in the test/ directory, like this:
+* Features
 
-               $ test
+       The source code is designed to allow for different operating
+       system builds of the eglib code.
 
-       Once the tests pass, run them with valgrind to ensure that
-       there are no leaks, like this:
+       Files in src that:
 
-               $ valgrind test
+         * Have a plain name: are cross platform, and should work on
+           every operating system.
 
-        You can also run the tests against the original glib, to do
-       this, use:
+         * That end in -unix.c: These files contain Unix specific code.
 
-               $ cd test
-               $ ./other
+         * That end in -win32.c: These files contain Win32 specific code.
+
+         * That end in -posix.c: Will work on both Windows and Unix,
+            but should not be included for other operating systems. 
 
 * Plans: short and long term.
 
@@ -37,11 +41,8 @@ no separate files, please try to follow the convetions in the source code
        build with it instead of using glib, gmodule and gthread, but
        the default build will continue to be done against glib 2.0.
 
-       Our first target is to make this work with Linux, other
-       platforms will follow after that.
-
-       In the long-term (Mono 2.0) we are considering dropping glib
-       as a dependency, considering that Mono requires a modern Unix
+       In the long-term we are considering dropping glib as a
+       dependency, considering that Mono requires a modern Unix
        system to run anyways (for its thread support) it would allow
        us to fix some of the glib API limitations we have to live
        with (explicit thread support for example), rework the API to