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 product through the predefined ReadmeDlg dialog box (defined on the Tarma Installer Installer Dialogs project page) if desired. The information that you provide here should be concise and immediately relevant for the installation process.

The Readme information itself is defined through one or more Rich Text resources on the Rich Texts project page.

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.

The predefined ReadmeDlg dialog box uses a RichText control to display the information. You can create additional dialog boxes with similar controls if you need to display other pre- or post-installation texts.

How to include Readme information in your project

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

1. Select the Rich Texts project page in the navigation panel on the left.
2. Create a new Rich Text resource or import an existing plain or rich text file.
3. Enter the desired text into the main text field.
4. Create or import additional Rich Text resources if you want to provide localized versions of the Readme information.
5. Select the Tarma Installer Installer Dialogs project page in the navigation panel on the left.
6. Select the predefined ReadmeDlg dialog box in the Dialogs tree.
7. Click on the large text control in the dialog box preview. This displays the RichText attributes for the MainText control.
8. In the RTF name field, enter the name of the Rich Text resource that you want to display, or click ... (browse) to select the resource name from a list.
9. To localize the Readme text, repeat the previous step for additional languages. Make sure that the RTF name field is localized (the * button must appear pressed in). Before specifying additional resource names, select the project language in the main toolbar, or click the button to open the Edit Localized String dialog box to edit all languages there.
10. Select the Symbolic Variables project page in the navigation panel on the left.
11. Select the UIReadmePage symbolic variable in the list, and make sure that its Value attribute is set to 1.