extras/types/Currency: note on double vs int.
[sdk] / portable / README
1
2 This is the portable version of Ecere SDK
3
4 Please see ecere-sdk/README for general information about Ecere SDK.
5
6  * FLAVORS *
7
8 The Portable Ecere SDK comes in 4 flavors:
9
10    * 'Core'
11    * 'MinGW'
12    * 'MinGW C++'
13    * 'All In One'
14
15 'Core' is the bare minimum. It contains only the Ecere SDK and it's little
16 documentation. Use it only if you have your own compiler installation.
17 For example, if you already have MinGW installed on the machine or machines
18 where you plan to use the Portable Ecere SDK. Be aware that different
19 versions of the MinGW components might create problems.
20
21 'MinGW' adds MinGW (make, binutils, gcc and gdb) and upx to 'Core'. This is
22 provinding you with a complete compiler and toolchain out of the box. This
23 includes the debugger for working out bugs in your projects. You won't have
24 to rely on a local installtion of a compiler. Note that only the C compiler
25 of MinGW is included.
26
27 'MinGW C++' simply adds MinGW's C++ compiler to the 'MinGW' flavor.
28
29 'All In One' adds many samples and the source code for Ecere SDK on top of
30 the 'MinGW C++' flavor.
31
32  * DOWNLOAD *
33
34    http://code.google.com/p/ecere/downloads/list
35
36
37  * USAGE *
38
39 You can run the ide and documentor using ide.bat and documentor.bat
40 respectively. You can do this at the command prompt or in your file manager.
41 If you want to build your project from the command prompt or just play with
42 the compiler, you can use console.bat for that purpose. It will setup the
43 search paths necessary to do so. Note that when simply using the IDE, the
44 compiler configuration takes care of that.
45
46 The packages for each flavor provide a 'home' folder where you may keep your
47 projects but the ide will track the paths to your projects and other files
48 relative to the current location of the portable binaries.
49
50  * DETAILS *
51
52 The Portable Ecere SDK is only available for Windows right now. A Linux
53 version should be possible. Please contact the Ecere community if your are
54 interested in hacking any other version of the Ecere SDK.
55
56 The Portable Ecere SDK is built from the exact same source code as the Ecere
57 SDK itself. The binaries provided are identical to the ones that would be
58 copied onto your machine if you used the official Ecere SDK installer.
59
60 What makes the SDK behave as portable is the fact that the configuration
61 file is present in the same directory as the binaries.
62
63 All flavors contain all available internationalization files so you may want
64 to set the LANGUAGE environment variable to use the Ecere SDK and MinGW in
65 your prefered language. Note that you may find the i18n of Ecere SDK to be
66 limited. Please help us with the translation effort.
67
68    https://translations.launchpad.net/ecere
69
70 The packages for the different flavors of the Portable Ecere SDK are
71 assembled from a github.com repository.
72
73    https://github.com/redj/dist-portable-ecere-sdk
74
75 We suggest that to be qualified as portable an application should follow
76 these simple rules.
77
78    * be packaged as a simple zip (or other compression format) archive
79    * don't require an installer, simply extract archive to desired location
80    * don't 'pollute' the system with configuration
81    * enable transportation of the installation
82      (on a usb key for example that may change drive letter from use to use)
83    * gracefuly handle transportation with relative paths when possible
84