eea89f520a8649eb38856bbc36619b93f31408ff
[mono.git] / eglib / README
1
2 The purpose of eglib is to be an X11-licensed subset of glib that can
3 be used with Mono when the Mono runtime is explicitly relicensed under
4 a different license by Novell.
5
6 The implementation is done from the public documentation available here:
7
8     http://developer.gnome.org/doc/API/2.0/glib/
9
10 Currently this is only being built standalone, use:
11
12           ./autogen.sh --prefix=/tmp/test
13
14 Currently all the definitions go into a single file: glib.h, there are 
15 no separate files, please try to follow the convetions in the source code
16
17 * Tests
18         
19         Please read the README in tests/
20
21 * Features
22
23         The source code is designed to allow for different operating
24         system builds of the eglib code.
25
26         Files in src that:
27
28           * Have a plain name: are cross platform, and should work on
29             every operating system.
30
31           * That end in -unix.c: These files contain Unix specific code.
32
33           * That end in -win32.c: These files contain Win32 specific code.
34
35           * That end in -posix.c: Will work on both Windows and Unix,
36             but should not be included for other operating systems. 
37
38 * Plans: short and long term.
39
40         The short term plans for eglib is to allow Mono to optionally
41         build with it instead of using glib, gmodule and gthread, but
42         the default build will continue to be done against glib 2.0.
43
44         In the long-term we are considering dropping glib as a
45         dependency, considering that Mono requires a modern Unix
46         system to run anyways (for its thread support) it would allow
47         us to fix some of the glib API limitations we have to live
48         with (explicit thread support for example), rework the API to
49         use types from stdint.h and we would be able to drop three
50         external shared libraries.
51
52         This would reduce memory usage for the handful of routines
53         that we use from glib, dynamic linker overhead for those and
54         would allow us to tune the implementation to Mono's needs.