source: trunk/tools/OdinBug/readme.source@ 9650

Last change on this file since 9650 was 9650, checked in by sandervl, 23 years ago

HB: Updated to version 0.5.8

File size: 2.4 KB
Line 
1Sourcecode for OdinBug 0.5.8
2============================
3
4
5A. How to compile OdinBug
6
7 1. Create a project folder named OdinBug in your
8 VX-REXX projects folder.
9
10 2. Unzip this OdinBugSrc058.ZIP in this folder.
11
12 3. Open OdinBug.VRP using VRXedit.
13
14B. Conventions that are used by me in this project:
15
16 First of all, the source is not well documented, sorry,
17 this will improve in the future.
18
19 1. Variables, GUI object names and INI keys for one
20 information should have one name, for instance:
21
22 Variable name: Logfile
23 GUI Object: EF_Logfile (indicating an Entryfield)
24 INI-Key: Logfile (case sensitive!)
25
26 I think there are two exceptions to this rule in the
27 project (these were accidents).
28
29 2. I do not store any information directly in a GUI object,
30 i.e. for every purpose, there exists a variable and (if
31 necessary) a GUI object. Appropriate measures have to be
32 taken to syncronize these two (or three). Check for event
33 routines tied to the entryfields on the settings page and
34 for the subroutines _GUIInit, _GUIEMailInit, _GUIRedraw and
35 _GUIRedraw2 to get an idea how I do this.
36
37 Please, no discussion, whether this is sensible or not.
38 I want it this way in OdinBug, and I ask you to respect
39 this (but you are welcome to tell me how to do it better
40 for my next program).
41
42 3. User defined subroutines should start with an underscore.
43 Note: The VX-REXX IDE has a bug, which makes it crash
44 if a routine beginning with underscore is deleted. So
45 you have to rename it before deleteing it.
46
47 Sorry, I did not know that before I introduced this
48 convention.
49
50 4. OdinBug does not (and should not) write anything to OS2.INI
51 or OS2SYS.INI! Everything should be written to OdinBug.INI
52 residing in the same directory as OdinBug.EXE.
53
54 5. OdinBug must run without it's INI file. There has to be a
55 reasonable default value for every single INI entry. If the
56 default value is empty, there has to be a line of comment
57 about that in the subroutine _INIRead.
58
59C. Please, share any changes you make, with me, because OdinBug
60 is still under development and I do not want different branches
61 with different bugs/features.
62
63D. Author:
64
65Herwig Bauernfeind, 10-01-2003
66EMail: herwig.bauernfeind@aon.at
Note: See TracBrowser for help on using the repository browser.