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