comment: add something about debian package

Z88dk is known to run on the following platforms: Amiga, BeOS, HP-UX 9, Linux, MacOS X, Solaris, Win32, Win16 and MSDOS. Binaries for the latest stable release (1.6) are available for Win32 and MacOS X.

You can choose to install the latest stable release (currently 1.6 dated 2005-05-05) or the current version from CVS. This wiki documents the z80 libraries as they are currently implemented in CVS.

The latest stable release will be missing several of the libraries documented here. However the libraries that are included are less likely to contain bugs and are less likely to have their APIs changed. The new libraries being developed in CVS may contain bugs and may have their APIs change to improve their usefulness. Since the time between stable releases tends to be long, it is recommended that you install the CVS version if the latest stable release is beginning to look a little bit old.

The latest stable release can be had from z88dk’s sourceforge download page. Scroll down to file releases and select the appropriate package to download for your platform. For Win32 and MacOSX there are binary packages available. Other platforms should get the generic C source. In the case of the latter, the z88dk binaries will have to be compiled with the help of a native C compiler and the guidelines mentioned below.

Unfortunately the exe installer only runs on Windows ME and above. For earlier versions of Windows follow these steps:

• Download and unzip the generic 1.6 zip file into c:\. A c:\z88dk directory will be created while unzipping.
• Download the win32 binaries and unzip that into a temporary directory. Inside the temporary directory a new directory z88dk.bin.win32 will be created.
• Drag and drop all the files contained in the z88dk.bin.win32 directory into c:\z88dk. Answer yes to all to overwrite any existing files.
• Within c:\z88dk there should now be a bin directory; if not you have dragged and dropped incorrectly and you should repeat the last step.
• It is now safe to delete the temporary directory.

The following steps install native Win32 Gnu Utils and are necessary if you would like to compile the z80 libraries yourself. The 1.6 install comes with precompiled z80 libraries so this is optional.

• Download and unzip the gnu utils into c:\gnu.

The installation is complete with the exception of setting up environment variables which is described below.

NOTE: Without the help of an EXE installer it requires considerable effort to perform an install into any directory other than c:\z88dk.

Follow these steps for installation:

• Download and run the win32 exe installer. The installer allows z88dk to be placed in any directory of your choice, though c:\z88dk is recommended.
• Unzip the zip files contained in {z88dk}\libsrc, {z88dk}\src and {z88dk}\support in place.

The following steps install native Win32 Gnu Utils and are necessary if you would like to compile the z80 libraries yourself. The 1.6 install comes with precompiled z80 libraries so this is optional.

• Download and unzip the gnu utils into c:\gnu.

The installation is complete with the exception of setting up environment variables which is described below.

Z88dk’s CVS source repository is maintained at Sourceforge. To grab the latest CVS version you will need a CVS client running on your platform that will contact Sourceforge and either retrieve the repository or update the local version of the repository that you already have. The link just mentioned and this page provide instructions on how to set up CVS on your platform. Further instructions for specific architectures can be found below.

Tortoise CVS is highly recommended as CVS client software for Win32. It integrates directly into Windows Explorer allowing CVS actions to be initiated from the context menu associated with files and folders. To install Tortoise CVS follow these steps:

• Download and run the latest Tortoise CVS exe installer.
• Restart your computer.

We will use the 1.6 installer to generate files containing correct path information for the destination directory chosen for z88dk. Toward that end, follow these steps:

• Download and run the win32 exe installer. The installer allows z88dk to be placed in any directory of your choice, though c:\z88dk is recommended.
• With the 1.6 install complete, drag and drop the {z88dk}\bin and {z88dk}\lib\config directories to the desktop. These directories contain the win32 binaries and the files the installer generated with correct path information.
• Uninstall the 1.6 install just performed by running {z88dk}\unins000.exe

The following steps use Tortoise CVS to obtain a local copy of z88dk’s CVS tree:

• Navigate to the directory where you would like to create the z88dk tree with windows explorer. This should be the same directory where the exe installer installed 1.6 above.
• Right click in the folder to bring up the context menu and select “CVS checkout”. If you do not see this option, Tortoise CVS has not been installed correctly or you have not restarted your computer.
• Fill in the dialog that pops up as follows:
  • Protocol: pserver
  • Server: z88dk.cvs.sourceforge.net
  • Repository Folder: /cvsroot/z88dk
  • Username: anonymous
  • Module: z88dk
• Press OK

Tortoise CVS will contact Sourceforge and make a local copy of the z88dk repository. After a few minutes you will have a new z88dk directory with everything in it. In explorer, CVS directories will have a green checkmark next to them to indicate they are up-to-date. Files that you have modified will have an orange arrow to remind you they are different from what is in the repository. Files with blue question marks are your own files that do not come from the z88dk repository.

With the local copy of the repository present, replace the z88dk win32 binaries and config files dragged to the desktop earlier:

• Drag the bin directory from the desktop to {z88dk}
• Drag the config directory from the desktop to {z88dk}\lib. Answer yes to all to allow overwriting of files.

The following steps install native Win32 Gnu Utils and are necessary in order to compile the z80 libraries yourself. The z80 libraries retrieved via CVS are not necessarily the latest compiles. It is recommended that you make the z80 libraries yourself following the install. This is described in the next section of the wiki.

• Download and unzip the gnu utils into c:\gnu.

The CVS install is complete with the exception of setting up environment variables which is described below.

NOTE: If any bugfixes are announced or you would like to stay current with the latest in z88dk, simply right click on the z88dk directory and choose “update” to have Tortoise CVS get updates from the repository. It is that easy to stay up-to-date.

Very little to say, just note that as for almost every programming kit z88dk requires the PATH environment variable to include the <application root>/z88dk/bin directory.

It is used by ZCC to find the target dependent configuration files. It should be set to point to <application root>/z88dk/lib/config.

It is the root path for the library files. It should be set to point to <application root>/z88dk/lib.