Package structure
The standard Tycho package structure is as follows. The installation
and configuration scripts assume this structure. A package called
pakman
is being developed that will make construction of
a new package with this structure automatic.
-
package/
-
-
makefile
README.txt
package.tcl
pkgIndex.tcl
*.tcl
*.itcl
- Makefile, package index and load files, and Tcl and
[incr Tcl] source files
-
adm/
- The admin directory, containing release
notes, announcements, and so on. This directory is not
included in the distribution itself.
-
dist/
- The distribution directory. The contents of this
directory are automatically generated.
-
bin/
- Shell scripts that start
tclsh
, itclsh
,
wish
, or itkwish
, load the package, and
do something useful.
-
makefile
-
-
demo/
- Demo directory, consisting of a collection of scripts
that each run a demo of the package.
-
makefile
-
-
doc/
-
-
makefile
index.html
*.html
- Package documentation. Documentation can be split
into subdirectories
-
codeDoc/
- Automatically-generated documentation.
-
internals/
- Programmer's guides (optional).
-
usersGuides/
- User's guides, for packages that supply
user interfaces (optional).
-
img/
- Image files used in the documentation
-
*.gif
makefile
-
src/
- Source files used for building binary extensions.
The structure of this directory hasn't been decided.
-
makefile
-
test/
-
-
all.itcl
alltests.itcl
- Files automatically generated from
makefile
rules.
-
makefile
*.tcl
*.itcl
Copyright © 1998, The Regents of the University of California.
All rights reserved.
Last updated: 06/08/98,
comments to: johnr@eecs.berkeley.edu