Updated LICENSE, INSTALL; Added README
[sdk] / README
1 The Ecere SDK v0.44 - http://ecere.com
2
3 The Ecere SDK is a cross-platform toolkit for building software applications.
4 It currently runs on Windows, Linux, and Mac OS X (through X11).
5 With the Ecere SDK, you can develop applications once and deploy them on all 
6 supported platforms alongside a lightweight runtime environment.
7 It introduces eC, an object oriented language derived from and fully compatible
8 with C, compromising neither runtime performance nor ease of use.
9 A built-in 3D engine supporting both Direct3D and OpenGL is fully integrated.
10
11 -----------------------------------------------------------------------------
12
13  * INSTALLATION *
14
15 Please refer to the latest instructions at http://ecere.com/wiki/
16
17 To build from source, simply type make.
18
19 It should build fine on Linux, on Windows with MinGW,
20 and on Mac OS X with a bit of luck.
21
22 To install, type make install.
23
24 Please note that at this time eC and the Ecere SDK only support 32 bit.
25 However, you should still be able to use the 32 bit version on a 64 bit machine.
26 64-bit support is planned for the future.
27
28  * DOCUMENTATION *
29
30 The Ecere Tao of Programming is a Programmer's Guide (still work in progress)
31 that will teach you the foundations of eC and Ecere. You will find it under:
32
33 On Windows:    %PROGRAMFILES%\Ecere SDK\doc\Ecere Tao of Programming [work in progress].pdf
34 On Linux/Unix: /usr/share/doc/tao.pdf
35
36 Please refer the samples that come with the SDK:
37
38 On Windows they get installed in %APPDATA%\Ecere SDK\Samples
39 On Linux/Unix they get installed in /usr/share/ecere/samples/
40 You can also find the latest versions on GitHub:
41
42 http://github.com/ecere/sdk/tree/master/samples
43
44 The Documentor is a tool under development to browse and document the APIs of
45 eC modules. You can use it to browse all available classes, methods and properties
46 of the Ecere runtime library.
47 However, at the moment the tool itself is being improved, and so not much 
48 descriptive info has been added yet.
49
50  * COMMUNITY *
51
52 Git Repository @ http://github.com/ecere/sdk/  ( git://github.com/ecere/sdk.git )
53 Support forums @ http://ecere.com/forums
54 Bug tracker    @ http://ecere.com/mantis
55 IRC            @ #ecere on irc.freenode.net