Removed version numbering from installer package internal identifier

[OSXPackageBuilder.git] / Packagemaker Instructions.txt

diff --git a/Packagemaker Instructions.txt b/Packagemaker Instructions.txt
index eb1fcf3..11056c4 100644 (file)
--- a/Packagemaker Instructions.txt
+++ b/Packagemaker Instructions.txt
@@ -1,8 +1,11 @@
 Packagemaker instructions
 
-The following gives raw information on what settings need to be edited when creating a new Privoxy package when starting from a new project in Packagemaker.
+The following gives raw information on what settings need to be edited when creating a new Privoxy package when starting from a new project in Packagemaker. You should NOT need to follow all of these instructions if you are starting from one of the Packagemaker project files (*.pmdoc) already present in this directory.
+
+At the end of the document are some additional (very) useful notes regarding certain Packagemaker quirks and bugs.
+
+Each section in this document from here on relates to one entry tab in the Packagemaker interface - you should populate each tab in the order presented below.
 
-At the end of the document are some additional (very) useful notes.
 
 
 Package Properties
@@ -13,7 +16,7 @@ Minimum target depends on which release is being built.
 
 Distribution Configuration
 
-Title is, for example, Privoxy 3.0.19
+Title is 'Privoxy X.Y.ZZ' without the quotes and replacing X.Y.ZZ with the version being packaged (e.g. Privoxy 3.0.19).
 User sees easy install only
 Untick all 'Installation Destination' checkboxes to ensure root volume is selected by default (this will result in a warning when building package).
 No Description (apparently this is only displayed on the Custom Install page)
@@ -34,12 +37,12 @@ Empty.
 Edit Interface
 
 Background is empty.
-Copy and paste texts from file 'pkg texts' to the relevant entry box on the left (having selected the 'embedded' radio button on the right). The license can be a File reference to ../current/LICENSE.
+Copy and paste texts from file 'pkg texts' to the relevant entry box on the left (having selected the 'embedded' radio button on the right). The license can be a File reference to the file LICENSE in the directory containing Privoxy's source code (likely ../current or ../dist).
 
 
 Pkg Content
 
-Once the Privoxy build instructions have been completed and the 'prepare package content.sh' script has been run successfully, drag and drop the folder 'pkg content' into the Contents pane of Packagemaker.
+Once the Privoxy build instructions have been completed and the 'constructPkgContent.sh' script has been run successfully, drag and drop the folder 'pkg content' into the Contents pane of Packagemaker.
 
 No changes need be made to the Choice: pkg content Configuration or Requirements.
 
@@ -49,8 +52,8 @@ Package: pkg content Configuration
 
 Destination is /
 No custom location
-The Package Identifier should be in the form: 'org.ijbswa.privoxy3019.pkg'. This value also needs to be plugged into the uninstall.command script since I have not yet worked out how to do that programmatically from one of the pre/postinstall scripts.
-Package Version is irrelevant.
+The Package Identifier _MUST_ be: 'org.ijbswa.privoxy.pkg'. This is important since the uninstall.command script references this identifier.
+Package Version should match the version of Privoxy being built.
 Restart Action: None
 Require admin authentication should be ticked.
 Open the Package Flags window (Package>Package Flags...) and tick Discard Resource Forks.