installer: Updated LICENSE, NEWS, README, i18n, templates for 0.44.14
[sdk] / README.md
similarity index 53%
rename from README
rename to README.md
index 52e3edf..d5f0690 100644 (file)
--- a/README
+++ b/README.md
@@ -1,11 +1,9 @@
-The Ecere SDK v0.44.13 - http://ecere.org
+# The [Ecere SDK](http://ecere.org) v0.44.14
+#### Free Open Source Software released under the New BSD license
 
-Free Open Source Software released under the New BSD license.
+The **Ecere SDK** is a Software Development Kit including:
 
-The Ecere SDK is a Software Development Kit including:
-
-   * A set of compiling tools for the eC programming language
-                               ( http://ec-lang.org )
+   * A set of compiling tools for the **[eC programming language](http://ec-lang.org)**
 
    * An Integrated Development Environment, with the usual features such as:
       - A source code editor with auto-completion, syntax highlighting
@@ -14,8 +12,10 @@ The Ecere SDK is a Software Development Kit including:
       - A Rapid Application Development form designer, based on
         properties & methods 
 
+![Ecere IDE Screenshot](http://ecere.com/wiki/images/0/01/IdeShotSept2011.png)
+
    * A run time library, providing a uniform API across platforms, featuring:
-      - A GUI toolkit (with a vast collection of powerful controls:
+      - A GUI toolkit (with a vast collection of powerful controls:  
         Buttons, Edit boxes, Drop/Combo boxes, Menus, Tabs,
         Tree views/Grids/List boxes, file dialogs, ...)
       - A 2D graphics API (bitmaps, fonts, international text, basic drawing)
@@ -26,6 +26,10 @@ The Ecere SDK is a Software Development Kit including:
       - System functionality such as file access, multi-threading &
         synchronization, handling date & time, etc.
 
+![Ecere Games Screenshot](http://ecere.com/shots/games.jpg)
+
+![GNOSIS Screenshot](http://ecere.com/wiki/images/7/76/NorthWest.jpg)
+
    * Additional libraries and code for more features, such as:
       - The Ecere Data Access (EDA) layer, an abstract relational database
         API, providing an active record system for eC. Currently it has
@@ -37,47 +41,48 @@ The Ecere SDK is a Software Development Kit including:
       - SSL Sockets suport through OpenSSL
       - A 2D tiled based game graphics engine (Tiled map, Sprites, A*)
 
+![Acovel Media Player Screenshot](http://ecere.com/wiki/images/7/72/Acovel3.png)
+
 -----------------------------------------------------------------------------
 
- * INSTALLATION *
+## INSTALLATION
 
-Please refer to the latest instructions at http://ecere.org/install
-Windows binaries are available from that page.
+Please refer to the latest instructions at http://ecere.org/install.
 
-Daily-built Ubuntu Debian packages are available from our Ubuntu PPA:
+Windows binaries are available from that page.
 
-   https://code.launchpad.net/~ecere-team/+archive/ppa
+Daily-built Ubuntu Debian packages are available from our [Ubuntu PPA](https://code.launchpad.net/~ecere-team/+archive/ppa).
 
-To build from source, simply type make (mingw32-make on Windows).
+To build from source, simply type 'make' ('mingw32-make' on Windows).
 
-It should build fine on Linux, on Windows with MinGW or MinGW-w64,
+It should build fine on Linux, on Windows with [MinGW](http://mingw.org/) or [MinGW-w64](http://mingw-w64.org/),
 on Mac OS X with Xcode command line tools installed or on FreeBSD (with gmake).
 
-Executables can also be deployed to the Android platform using the Android NDK.
+To install, type 'make install' ('mingw32-make install' on Windows).
 
-   Please refer to http://ecere.org/android
+64-bit is now supported.
 
-To install, type make install (mingw32-make install on Windows).
+Executables can also be deployed to the Android platform using the Android NDK. Please refer to http://ecere.org/android
 
-64-bit is now supported.
 
- * DOCUMENTATION *
+## DOCUMENTATION
+[![Tao](http://ecere.com/images/tao.png)](http://ecere.org/tao.pdf)  
+The [Ecere Tao of Programming](http://ecere.org/tao.pdf) is a Programmer's Guide (still work in progress)
+that will teach you the foundations of eC and Ecere. You will find it under:  
+
+   *(Windows)*    %PROGRAMFILES%\Ecere SDK\doc\Ecere Tao of Programming [work in progress].pdf  
+   *(Linux/Unix)* /usr/share/doc/tao.pdf
 
-The Ecere Tao of Programming is a Programmer's Guide (still work in progress)
-that will teach you the foundations of eC and Ecere. You will find it under:
+Please check out the [samples](http://github.com/ecere/ecere-sdk/tree/master/samples) that come with the SDK.
 
-Online: http://ecere.org/tao.pdf
-On Windows:
-      %PROGRAMFILES%\Ecere SDK\doc\Ecere Tao of Programming [work in progress].pdf
-On Linux/Unix: /usr/share/doc/tao.pdf
+You can see a list of the most interesting ones as well as prebuilt binaries at http://ecere.org/software.
 
-Please check out the samples that come with the SDK:
+When installing the SDK, the samples get installed in:
 
-On Windows they get installed in %APPDATA%\Ecere SDK\Samples
-On Linux/Unix they get installed in /usr/share/ecere/samples/
-You can also find the latest versions on GitHub:
+   *(Windows)*      %APPDATA%\Ecere SDK\Samples  
+   *(Linux/Unix)*   /usr/share/ecere/samples/
 
-   http://github.com/ecere/ecere-sdk/tree/master/samples
+On Unix you might need to make a copy to a directory with write permissions in order to compile them.
 
 The Documentor is a tool under development to browse and document the APIs of
 eC modules. You can use it to browse all available classes, methods and properties
@@ -85,11 +90,9 @@ of the Ecere runtime library. It is available from the Help menu in the IDE (F1)
 However, at the moment the tool itself is being improved, and so not much 
 descriptive info has been added yet.
 
- * COMMUNITY *
+## COMMUNITY
 
-Git Repository @ http://github.com/ecere/ecere-sdk/
-                ( git://github.com/ecere/ecere-sdk.git )
-Support forums @ http://ecere.org/forums
-Bug tracker    @ http://ecere.org/mantis
-IRC            @ #ecere on irc.freenode.net
-                ( http://webchat.freenode.net/?channels=ecere )
+[Git Repository](http://github.com/ecere/ecere-sdk/) ( git://github.com/ecere/ecere-sdk.git )  
+[Support forums](http://ecere.org/forums)  
+[Bug tracker](http://ecere.org/mantis)  
+[IRC](http://webchat.freenode.net/?channels=ecere) - **#ecere** on irc.freenode.net