The Ecere SDK - sdk/blob - README.md

   1 # The [Ecere SDK](http://ecere.org) v0.44.15
   2 #### Free Open Source Software released under the New BSD license
   3
   4 The **Ecere SDK** is a Software Development Kit including:
   5
   6    * A set of compiling tools for the **[eC programming language](http://ec-lang.org)**
   7
   8    * An Integrated Development Environment, with the usual features such as:
   9       - A source code editor with auto-completion, syntax highlighting
  10       - Management of application and library projects
  11       - A visual debugger
  12       - A Rapid Application Development form designer, based on
  13         properties & methods
  14
  15 ![Ecere IDE Screenshot](http://ecere.com/wiki/images/0/01/IdeShotSept2011.png)
  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 ![Ecere Games Screenshot](http://ecere.com/shots/games.jpg)
  30
  31 ![GNOSIS Screenshot](http://ecere.com/wiki/images/7/76/NorthWest.jpg)
  32
  33    * Additional libraries and code for more features, such as:
  34       - The Ecere Data Access (EDA) layer, an abstract relational database
  35         API, providing an active record system for eC. Currently it has
  36         drivers for a minimal Ecere RDBMS and SQLite (as well as an encrypted
  37         version using SQLCipher), and recently a basic Oracle driver was
  38         introduced
  39       - An audio library (supporting DirectSound on Windows and ALSA on Linux)
  40       - WIA Scanning support on Windows
  41       - SSL Sockets suport through OpenSSL
  42       - A 2D tiled based game graphics engine (Tiled map, Sprites, A*)
  43
  44 ![Acovel Media Player Screenshot](http://ecere.com/wiki/images/7/72/Acovel3.png)
  45
  46 -----------------------------------------------------------------------------
  47
  48 ## INSTALLATION
  49
  50 Please refer to the latest instructions at http://ecere.org/install.
  51
  52 Windows binaries are available from that page.
  53
  54 Daily-built Ubuntu Debian packages are available from our [Ubuntu PPA](https://code.launchpad.net/~ecere-team/+archive/ppa).
  55
  56 To build from source, simply type 'make' ('mingw32-make' on Windows).
  57
  58 It should build fine on Linux, on Windows with [MinGW](http://mingw.org/) or [MinGW-w64](http://mingw-w64.org/),
  59 on Mac OS X with Xcode command line tools installed or on FreeBSD (with gmake).
  60
  61 To install, type 'make install' ('mingw32-make install' on Windows).
  62
  63 64-bit is now supported.
  64
  65 Executables can also be deployed to the Android platform using the Android NDK. Please refer to http://ecere.org/android .
  66
  67 They can also deployed to the Web using [Emscripten](http://emscripten.org). Please refer to http://ecere.org/web .
  68
  69 ## DOCUMENTATION
  70 [![Tao](http://ecere.com/images/tao.png)](http://ecere.org/tao.pdf)
  71 The [Ecere Tao of Programming](http://ecere.org/tao.pdf) is a Programmer's Guide (still work in progress)
  72 that will teach you the foundations of eC and Ecere. You will find it under:
  73
  74    *(Windows)*    %PROGRAMFILES%\Ecere SDK\doc\Ecere Tao of Programming [work in progress].pdf
  75    *(Linux/Unix)* /usr/share/doc/tao.pdf
  76
  77 Please check out the [samples](http://github.com/ecere/ecere-sdk/tree/master/samples) that come with the SDK.
  78
  79 You can see a list of the most interesting ones as well as prebuilt binaries at http://ecere.org/software.
  80
  81 When installing the SDK, the samples get installed in:
  82
  83    *(Windows)*      %APPDATA%\Ecere SDK\Samples
  84    *(Linux/Unix)*   /usr/share/ecere/samples/
  85
  86 On Unix you might need to make a copy to a directory with write permissions in order to compile them.
  87
  88 The Documentor is a tool under development to browse and document the APIs of
  89 eC modules. You can use it to browse all available classes, methods and properties
  90 of the Ecere runtime library. It is available from the Help menu in the IDE (F1).
  91 However, at the moment the tool itself is being improved, and so not much
  92 descriptive info has been added yet.
  93
  94 ## COMMUNITY
  95
  96 [Git Repository](http://github.com/ecere/ecere-sdk/) ( git://github.com/ecere/ecere-sdk.git )
  97 [Support forums](http://ecere.org/forums)
  98 [Bug tracker](http://ecere.org/mantis)
  99 [IRC](http://webchat.freenode.net/?channels=ecere) - **#ecere** on irc.freenode.net