Hey guys, I did a search but came up empty. Do you guys typically include a ReadMe.txt with your installation? If so, do you have a standard template you follow? I could see ReadMe.txt's being useful especially in cases where the MSI takes public properties.
0 Comments   [ + ] Show Comments

Comments

Please log in to comment

Rating comments in this legacy AppDeploy message board thread won't reorder them,
so that the conversation will remain readable.

Answers

0
It depends on the client but I like to use them in any event and leave one alongside the MSI. Here's a template I've introduced to 3 clients so far. It looks a bit of a mess here because the TABs between entry locations don't format properly but, pasted into a text editor, they should resolve OK.'//------------------------------------------------------------------------------------------------------------//
' All Users of this application should refer queries to the helpdesk
'//------------------------------------------------------------------------------------------------------------//
Application Title : [Application Name]
Version : 00.00
LV Release : 01
Original script creation date : 1st Jan 2008
Summary of Application : (what does the app do?)
Packager name :
Application Owner :
Business Unit(s) :
Name 1 :
Number 1 :
In-house / 3rd Party Application : IH/TP
Sites where required
All/London/Birmingham : All
Company : MyCompany (London), MyCompany (W. Midlands)

'//------------------------------------------------------------------------------------------------------------//
' Vendor contact details
'//------------------------------------------------------------------------------------------------------------//
Company Name : [Vendor Name]
Web page URL : www.vendorname.com
Contact name :
Address :
Tel :
Fax :
Email :

'//------------------------------------------------------------------------------------------------------------//
' License information
'//------------------------------------------------------------------------------------------------------------//

Global License : Yes / No If No, please supply license information
Number of Licenses : X
Procurement Informer : Name of procurement person

'//------------------------------------------------------------------------------------------------------------//
' Dependencies
'//------------------------------------------------------------------------------------------------------------//

List any dependencies that the application has e.g. .Net Framework v1.1 or above

'//------------------------------------------------------------------------------------------------------------//
' Application implementation
'//------------------------------------------------------------------------------------------------------------//

Package type : Vendor MSI with MST/Repackaged/Wrapped vendor EXE
Installation steps :

Run Setup.EXE

Screen title Action
============ ======
Welcome Click 'Next'
Setup type Check the 'Custom Install' option
Personal Information
Proxy Settings
Enter the following:
Proxy path: remote_proxy_ip_address
Proxy Port: proxy-port_nbr
Click 'Next'
Select Components Click 'Next'
Ready for Install Click 'Install'

Files begin to be copied

Completing the Acturis Assistant Setup Wizard Allow the system to reboot.

'//------------------------------------------------------------------------------------------------------------//
' Application config summary
'//------------------------------------------------------------------------------------------------------------//

Comment here on additional information that the application may require, e.g. proxy server settings

- Using 'Administrator options' on 'Installation Expert' screen
- Set install type to per-user
- Suppressed reboots and reboot prompts

- Created properties as follows:
Property Data
======== ====

- Edited properties as follows:
Property Data
======== ====

'//------------------------------------------------------------------------------------------------------------//
' Conflict management notes
'//------------------------------------------------------------------------------------------------------------//

Detail your reasons for ignoring any file/registry conflicts

'//------------------------------------------------------------------------------------------------------------//
' Merge module employed?
'//------------------------------------------------------------------------------------------------------------//

Detail any merge module(s) used here

'//------------------------------------------------------------------------------------------------------------//
' Side-by-side DLL/COM re-direction employed?
'//------------------------------------------------------------------------------------------------------------//

Detail any Com / DLL references here

'//------------------------------------------------------------------------------------------------------------//
' Calls to customisation scripts from this application
'//------------------------------------------------------------------------------------------------------------//

List the full name/path to any script/EXE called from this script

'//------------------------------------------------------------------------------------------------------------//
' Group information
'//------------------------------------------------------------------------------------------------------------//
Domain : Company Domain
Global Group : appMyApp
Domain Local : _appMyApp

'//------------------------------------------------------------------------------------------------------------//
' Special notes / Group-specific considerations
'//------------------------------------------------------------------------------------------------------------//

Comment here on any other miscellaneous information

'//------------------------------------------------------------------------------------------------------------//
' Permissioning applied (if any)
'//------------------------------------------------------------------------------------------------------------//

Please include any directory / registry permissioning here.

'//------------------------------------------------------------------------------------------------------------//
' Known issues / compatibility issues
'//------------------------------------------------------------------------------------------------------------//

List any compatibility or other known issues here

'//------------------------------------------------------------------------------------------------------------//
' Testing procedures
'//------------------------------------------------------------------------------------------------------------//
Tested on London build : Yes / No
Tested on Birmingham build : Yes / No

Comment here on your testing process and any anomalies encountered

'//------------------------------------------------------------------------------------------------------------//
' QA section
'//------------------------------------------------------------------------------------------------------------//

Date Released : dd Mmm YYYY
QA Releaser : MyName
QA Comments : QA Comments

'//------------------------------------------------------------------------------------------------------------//
' Custom Actions added
'//------------------------------------------------------------------------------------------------------------//

CA Name : MyCAName
Purpose : MyPurpose
Comments : MyComments

'//------------------------------------------------------------------------------------------------------------//
' Maintenance updates - Most recent first (reverse order)
'//------------------------------------------------------------------------------------------------------------//

ACTION DATE : dd Mmm YYYY
UPDATE NUMBER : 01
UPDATE PERFORMED BY : MyName
Description : MyDescription
Answered 03/23/2009 by: VBScab
Red Belt

Please log in to comment
0
Cool, thanks sire.
Answered 03/23/2009 by: jayteeo
Purple Belt

Please log in to comment
0
Hi Ian,

Do You mention any merge modules present in the Vendor msi in ReadMe.txt' file
Answered 03/25/2009 by: rakesh.kumar
Senior Yellow Belt

Please log in to comment
0
More or less slap bang in the middle is a section 'Merge modules employed'
Answered 03/25/2009 by: VBScab
Red Belt

Please log in to comment
Answer this question or Comment on this question for clarity