Check-in [dc273ce4f7]
Overview
Comment:Updated README
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:dc273ce4f75c95f2061fb4a9ee1cc21f47dd79c3
User & Date: rkeene on 2010-09-26 04:43:56
Other Links: manifest | tags
Context
2010-09-26
04:44
Reverted cleanup of tclExecutableName check-in: 0368915b0d user: rkeene tags: trunk
04:43
Updated README check-in: dc273ce4f7 user: rkeene tags: trunk
04:43
Updated to return in failure if we fail to properly install check-in: bdcfd6df7f user: rkeene tags: trunk
Changes

Modified README from [5eafd68bb0] to [bcca4a4827].

   104    104   	3. */build.sh installs software into "inst" (run-time + compile-time)
   105    105   	4. */build.sh installs run-time software into "out", this will be
   106    106   	   included in the Tclkit as if it were the root directory of the
   107    107   	   Tclkit (combined with other "out" directories)
   108    108   	5. kitsh/build.sh compiles a "main" function and links all the built
   109    109   	   libraries together into an executable
   110    110   	6. kitsh/build.sh combines all the "out" directories into one
   111         -	7. kitsh/build.sh creates a Metakit database from the combined
          111  +	7. kitsh/build.sh creates a Metakit or Zip database from the combined
   112    112   	   directories and appends that to the compiled executable using:
   113    113   		a. A Tclkit found in the environment variable "TCLKIT" (tclkit
   114    114   		   if unset) if it is functional; or
   115    115   		b. The built kit itself (does not work for cross-compiling)
   116    116   
   117    117   Details:
   118    118   	The general mechanism that enables a Tclkit to operate is a small Tcl
................................................................................
   158    158   the individual projects together into a single executable.  Its build script
   159    159   does not create an "inst" or an "out" directory because it is not a library.
   160    160   Instead, it collects all the other project's "out" directories into a single
   161    161   directory (starpack.vfs), as well a static file (boot.tcl).  It then compiles
   162    162   the source code, and then installs the Metakit database containing the VFS
   163    163   onto the resulting executable.
   164    164   
   165         -To create the Metakit database, one of two Tclkits is used (tried in this
   166         -order):
          165  +If the "mk4tcl" project fails to build (or is not requested to be built),
          166  +the rest of the project will be built using zip files instead of Metakit
          167  +databases.
          168  +
          169  +To create the Metakit database (if needed), one of two Tclkits is used (tried
          170  +in this order):
   167    171   	1. The Tclkit specified by the TCLKIT environment variable (or
   168    172   	   "tclkit" if that variable is not set) if it is functional; or
   169    173   	2. The built Tclkit itself
   170    174   
   171    175   The second method will not work if the built Tclkit is not executable on the
   172    176   current platform (i.e., in the case of cross-compilation) and so it may be
   173    177   necessary to bootstrap a runnable Tclkit first.