Packaging

- Finished first version of the OSX packaging document.

package-config/osx/README

@@ -56,9 +56,9 @@ Note: This is being written from the OSX 10.6 perspective, and may therefore
     
     $ make -j 2
 
-    If there are any errors, or there are any warnings generated by the compiler,
+    If there are any errors, or there are any warnings generated by the compiler
-    stop immediately, capture the output, and report the problem.  You'll need to
+    stop immediately, capture the output, and report the problem.  You'll need
-    watch as it builds.
+    to watch as it builds.
 
 4. Build the test suite
 
@@ -102,8 +102,8 @@ Note: This is being written from the OSX 10.6 perspective, and may therefore
 
 5. Assemble the parts
 
-  5.1 There is a script that puts all the files in the right place, ready for
+  5.1 There is a script that copies all the necessary files (binary, man pages
-    packaging.  Run this:
+    etc) in the right place, ready for packaging.  Run this:
 
     $ cd ~/task-package.git/package-config/osx
     $ ./update
@@ -114,15 +114,165 @@ Note: This is being written from the OSX 10.6 perspective, and may therefore
 
     $ open -a /Developer/Applications/Utilies/PackageManager.app   
 
-  6.2 Close the window that automatically opens.
+  6.2 Close the 'Untitled' window that opens - we will be using a different
+    file.  Note that PackageManager is still running - it just has no windows.
 
   6.3 Using the File -> Open menu, open the file
 
-    ~/task-package.git/packag-config/osx/task.pmdoc
+    ~/task-package.git/package-config/osx/task.pmdoc
 
+    <figure 1>
 
-  6.x Rename the package
+    This is the file from the last time a package was created.  It needs some
+    adjustments.  Start by clicking on the "Task x.x.x Distribution" with a
+    package icon in the top left part of the window.
 
-7. Test the package
+  6.4 Click on the "Configuration" button/tab.
+
+    - Change the "Title" to "Task 1.9.2"
+    - Change the "Description" to "Task 1.9.2 install for Snow Leopard"
+
+    <figure 2>
+
+  6.5 Click on "Edit Interface..."
+
+    There are 5 radio buttons on the left hand side - we will visit each and
+    make changes.  Click on "Background", make sure it matches the figure.
+
+    <figure 3>
+
+    Click on "Introduction", make sure it matches the figure.
+
+    <figure 4>
+
+    Click on "Read Me", and on the right hand side, under "Read Me Panel", click
+    on "File" and select the file:
+
+      ~/task-package.git/package-config/osx/README.txt
+
+    <figure 5>
+
+    Click on "License", and on the right hand side, under "License Panel", click
+    on "File" and select the file:
+
+      ~/task-package.git/package-config/osx/COPYING.txt
+
+    <figure 6>
+
+    Click on "Finish Up", and make sure it matches the figure.
+
+    <figure 7>
+
+    Close the Interface Editor window (it saves automatically).
+
+  6.6 Back in the "task.pmdoc" window, click on the "Requirements" tab/button,
+    then click on the "+" button, and add a requirement rule as shown in the
+    figure.
+
+    <figure 8>
+
+  6.7 Click on the "Actions" tab/button and make sure it matches the figure.
+
+    <figure 9>
+
+  6.8 Click on the triangle next to the "local" item in the "Contents" vertical
+    bar on th left to expand and show a folder called "local", with the path
+    "/usr/local", but click on the "local" next to the blue radio button, not
+    the one next to the folder.  Then click on the "Configuration" tab/button.
+
+    - Change the "Choice Name" to "local"
+    - Leave the "Identifier" alone - it is automatic
+    - Make sure "Selected" and "Enabled" are checked, but "Hidden" is not
+
+    <figure 10>    
+
+  6.9 Click on the "Requirements" tab/button and make sure it is all blank.
+
+    <figure 11>
+
+  6.10 Click on the blue folder on the left, which is labelled "local", and has
+    a path of "/usr/local".  Click on the "Configuration" tab/button.
+
+    - Change the "Install" to ~/task-package.git/package-config/osx/local
+    - Make sure the "Destination" is "/usr/local"
+    - Make sure "Allow custom location" is checked
+    - Make sure the "Package Identifier is "com.beckingham.task192.local.pkg"
+    - Make sure the "Package Version" is 1.0.  If you needed to make a
+      subsequent OSX package, *for the same version of task*, then this number
+      would be increased to show OSX that this package supersedes the earlier
+      one
+    - Make sure "Restart Action" is "None"
+    - Make sure "Require admin authentication" is checked
+    - Make sure "PAckage Location" is "Self-Contained"
+
+    <figure 12>
+
+  6.11 Click on the "Contents" tab/button.
+
+    - Click on all the triangles in the "local" folder to expand all directories
+    - Make sure "Include root in package is not checked"
+    - Click on the "Apply Recommendations" button
+
+    Make sure it matches the figure.
+
+    <figure 13>
+
+  6.12 Click on the "Components" tab/button, make sure it is all blank.
+
+  6.13 Click on the "Scripts" tab/button, make sure it is all blank.
+
+7. Building the package
+
+  7.1 Click on the "Build" hammer icon to build the package.
+
+  Provide a filename of "task-1.9.1-sl.pkg" for Snow Leopard (10.6), or
+  "task-1.9.2.pkg" for Leopard (10.5), and save it somewhere, for example the
+  Desktop.
+
+  All should succeed.  You can click on the "Return" button to end the build
+  phase, and you can quit PackageManager, but make sure you save the changes
+  you made, because you may need to go through the whole process again, if there
+  is an emergency change, or the package is somehow corrupt.
+
+  <figure 14>
+
+8. Test the package
+
+  8.1 Double-click on the package you just created, and install task.  You
+    should see the README file in the UI, and the COPYING file on another
+    page.  It should succeed.
+
+  <figure 14>
+  <figure 15>
+  <figure 16>
+  <figure 17>
+  <figure 18>
+  <figure 19>
+  <figure 20>
+  <figure 21>
+
+  8.2 Run the following commands to test the installation
+
+  $ /usr/local/bin/task version
+
+  task 1.9.2 built for darwin-ncurses
+  Copyright (C) 2006 - 2010 P. Beckingham, F. Hernandez.
+                                                                                                                     
+  Task may be copied only under the terms of the GNU General Public License,
+  which may be found in the task source kit.
+
+  Documentation for task can be found using 'man task', 'man taskrc', 'man
+  task-tutorial', 'man task-color', 'man task-faq' or at http://taskwarrior.org
+
+  $ man task
+  ...
+  ...
+  task 1.9.2             2010-05-22                task 1.9.2
+
+  The man page should list 1.9.2 as the version number, but the date will be
+  different.
+
+9. Email the package to Fredde.
+
+---
 
-  7.1 Run the following commands