README: Added eC link
[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 Software Development Kit including:
6
7    * A set of compiling tools for the eC programming language
8                                ( http://www.ecere.com/technologies.html#eC )
9
10    * An Integrated Development Environment, with the usual features such as:
11       - A source code editor with auto-completion, syntax highlighting
12       - Management of application and library projects
13       - A visual debugger
14       - A Rapid Application Development form designer, based on
15         properties & methods 
16
17    * A run time library, providing a uniform API across platforms, featuring:
18       - A GUI toolkit (with a vast collection of powerful controls:
19         Buttons, Edit boxes, Drop/Combo boxes, Menus, Tabs,
20         Tree views/Grids/List boxes, file dialogs, ...)
21       - A 2D graphics API (bitmaps, fonts, international text, basic drawing)
22       - A 3D graphics API, supporting both Direct3D and OpenGL
23         (3DS file format support)
24       - A networking API which provide Sockets as well as a
25         distributed objects system for eC
26       - System functionality such as file access, multi-threading &
27         synchronization, handling date & time, etc.
28
29    * Additional libraries and code for more features, such as:
30       - The Ecere Data Access (EDA) layer, an abstract relational database
31         API, providing an active record system for eC. Currently it has
32         drivers for a minimal Ecere RDBMS and SQLite (as well as an encrypted
33         version using SQLiteCipher), and recently a basic Oracle driver was
34         introduced
35       - An audio library (supporting DirectSound on Windows and ALSA on Linux)
36       - WIA Scanning support on Windows
37       - SSL Sockets suport through OpenSSL
38       - A 2D tiled based game graphics engine (Tiled map, Sprites, A*)
39
40 -----------------------------------------------------------------------------
41
42  * INSTALLATION *
43
44 Please refer to the latest instructions at http://ecere.com/wiki/
45 Windows binaries are available from that page.
46
47 Daily-built Ubuntu Debian packages are available from our Ubuntu PPA:
48
49    https://code.launchpad.net/~ecere-team/+archive/ppa
50
51 To build from source, simply type make (mingw32-make on Windows).
52
53 It should build fine on Linux, on Windows with MinGW,
54 and on Mac OS X with a bit of luck.
55
56 To install, type make install (mingw32-make install on Windows).
57
58 Please note that at this time eC and the Ecere SDK only support 32 bit.
59 However, you should still be able to use the 32 bit version on a 64 bit machine.
60 64-bit support is planned for the future.
61
62  * DOCUMENTATION *
63
64 The Ecere Tao of Programming is a Programmer's Guide (still work in progress)
65 that will teach you the foundations of eC and Ecere. You will find it under:
66
67 On Windows:
68       %PROGRAMFILES%\Ecere SDK\doc\Ecere Tao of Programming [work in progress].pdf
69 On Linux/Unix: /usr/share/doc/tao.pdf
70
71 Please check out the samples that come with the SDK:
72
73 On Windows they get installed in %APPDATA%\Ecere SDK\Samples
74 On Linux/Unix they get installed in /usr/share/ecere/samples/
75 You can also find the latest versions on GitHub:
76
77 http://github.com/ecere/sdk/tree/master/samples
78
79 The Documentor is a tool under development to browse and document the APIs of
80 eC modules. You can use it to browse all available classes, methods and properties
81 of the Ecere runtime library.
82 However, at the moment the tool itself is being improved, and so not much 
83 descriptive info has been added yet.
84
85  * COMMUNITY *
86
87 Git Repository @ http://github.com/ecere/sdk/  ( git://github.com/ecere/sdk.git )
88 Support forums @ http://ecere.com/forums
89 Bug tracker    @ http://ecere.com/mantis
90 IRC            @ #ecere on irc.freenode.net
91                 ( http://webchat.freenode.net/?channels=ecere )