Displaying Readme Information

It is customary for software products to include late-breaking information and tips in a Readme text file. Typically, the Readme information is displayed prior to or in the early stages of the installation process. Tarma Installer's Setup wizard will do this for your application on the Important Information page if desired. The information that you provide here should be concise and immediately relevant for the installation process.

Note - If you want the Readme information or a more extensive release notes document to be available after installation, you should also provide it as a separate document, which you install along with the rest of your application. In that case, it might be a good idea to install a shortcut to that document. See Installing Files and Installing Shortcuts for more information on these topics.

Text variants

The Installation - Readme information page allows you to enter more than one text variant. The primary purpose of these text variants is for multilingual support, where they allow you to provide localized texts to match the installation languages.

To match a text variant with a language, enter the desired text on the Readme Information page (if necessary, by creating a new text tab first with the New command). Assign it an identifier that you can easily memorize in the Text identifier field, then switch to the Installation - Languages page. On this page, use the Associated Readme Information field to link the text variant to the language(s) of your choice.

For more information about creating a multilingual installer, see Creating a Multilingual Installer Package.

How to include Readme information in your project

To include Readme information for use prior to installation, act as follows.

1. Select the Project - Readme Information page by clicking on its bullet in the Navigation area.
2. Make sure that the Include Readme information box is checked.
3. Enter the desired text into the main text field. If desired, you may import existing text from a file by clicking the Open... button (this will place the imported text in a newly created text variant).
4. To create further text variants, click New or Open...