[Bps-public-commit] r12824 - in Shipwright/trunk/lib/Shipwright: Manual

[spang at bestpractical.com]

Author: spang
Date: Mon Jun  2 18:31:15 2008
New Revision: 12824

Modified:
   Shipwright/trunk/lib/Shipwright/Manual.pm
   Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod

Log:
More documentation updates, to the Tutorial (explain how to use built vessels)
and update the Shipwright::Manual front page.

Modified: Shipwright/trunk/lib/Shipwright/Manual.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Manual.pm	(original)
+++ Shipwright/trunk/lib/Shipwright/Manual.pm	Mon Jun  2 18:31:15 2008
@@ -10,7 +10,16 @@
 
 =over 4
 
-=item L<Shipwright::Tutorial>
+=item L<Shipwright::Manual::Tutorial>
+
+A simple tutorial that leads through the creation of a simple Shipwright
+vessel.
+
+=item L<Shipwright::Manual::CustomizeBuild>
+
+A simple tutorial to help you know what shipwright generally is.
+
+=item L<Shipwright::Manual::UsingFlags>
 
 A simple tutorial to help you know what shipwright generally is.
 
@@ -23,4 +32,3 @@
 =cut
 
 1;
-

Modified: Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod	(original)
+++ Shipwright/trunk/lib/Shipwright/Manual/Tutorial.pod	Mon Jun  2 18:31:15 2008
@@ -4,14 +4,14 @@
 
 =head1 SYNOPSIS
 
-In this tutorial, we'll create a simple distribution: the L<Acme::Hello> module
+In this tutorial, we'll create a simple vessel: the L<Acme::Hello> module
 from CPAN.
 
 We will use C<svk://__shipwright/hello> as our repository.
 
 =head1 DESCRIPTION
 
-There are three main steps to creating a shipwright distribution.
+There are three main steps to creating a shipwright vessel.
 
 =head2 1. initialize
 
@@ -40,6 +40,22 @@
 
 Run C<shipwright help build> to see more options.
 
+And that's it! Your build should end with a bunch of lines beginning with
+C<Installing>. These specify where you can find your built vessel. This will
+generally be in a subdirectory of F</tmp>, but you can specify a different
+location with C<--install-base>.
+
+To ship your vessel, create an archive of the built files using an archive
+program such as C<tar>, e.g. by running C<tar czvf your-vessel.tar.gz
+/tmp/your-vessel>. Users can use your vessel by extracting the archive to a
+directory and then adding the following command to their shell's startup script
+(e.g. for bash users, edit F</home/user/.bashrc> on most systems): C<source
+/base/path/hello/etc/shipwright-source-bash> (for bash users). A source script
+is also provided for the tcsh shell. After sourcing this script, users will be
+able to run binaries and load perl modules from your vessel as with normal
+installed programs, though they will need to start a new shell or re-run their
+startup script.
+
 A log of the above commands can be found in F<docs/tutorial.log>.
 
 =head1 NOTES