Using README Files in a Distribution

Using README Files in a Distribution

Whenever a file named inst.README is located in a distribution directory, the content of the file is displayed whenever users specify the distribution directory during an installation session. README contents might be special instructions about the software in this distribution, cautions, or other information that users might need before starting an installation session.

Your can also use an HTML version of the README file. This file, inst.README.html, contains HTML rather than plain text and is displayed when the distribution is specified from Software Manager.