[Jifty-commit] r4612 - in Jifty-Book: .

jifty-commit at lists.jifty.org jifty-commit at lists.jifty.org
Tue Dec 4 00:28:22 EST 2007


Author: sterling
Date: Tue Dec  4 00:28:15 2007
New Revision: 4612

Modified:
   Jifty-Book/   (props changed)
   Jifty-Book/doc/Jifty/Book/Part-A/01-Introduction.pod
   Jifty-Book/doc/Jifty/Book/Part-A/02-Installing_Jifty.pod

Log:
 r14356 at dynpc145:  andrew | 2007-12-03 23:27:41 -0600
 * Use =for TODO and such instead of TODO to note TODO/FIXME/XXX comments.
 * Working on expanding a bit on installation. (Thanks Christian Ternus!)


Modified: Jifty-Book/doc/Jifty/Book/Part-A/01-Introduction.pod
==============================================================================
--- Jifty-Book/doc/Jifty/Book/Part-A/01-Introduction.pod	(original)
+++ Jifty-Book/doc/Jifty/Book/Part-A/01-Introduction.pod	Tue Dec  4 00:28:15 2007
@@ -56,7 +56,7 @@
 
 =head2 History
 
-TODO Jesse should write something here about how Jifty was started, why, etc...
+=for TODO Jesse should write something here about how Jifty was started, why, etc...
 
 =head2 Philosophy
 
@@ -120,11 +120,11 @@
 
 =head1 Audience for this Book
 
-TODO Add some information about the audience.
+=for TODO Add some information about the audience.
 
 =head1 Conventions in this Book
 
-TODO What are the conventions in this book. We don't know yet, do we? DO WE!?
+=for TODO What are the conventions in this book. We don't know yet, do we? DO WE!?
 
 =head2 Chapter Structure
 

Modified: Jifty-Book/doc/Jifty/Book/Part-A/02-Installing_Jifty.pod
==============================================================================
--- Jifty-Book/doc/Jifty/Book/Part-A/02-Installing_Jifty.pod	(original)
+++ Jifty-Book/doc/Jifty/Book/Part-A/02-Installing_Jifty.pod	Tue Dec  4 00:28:15 2007
@@ -6,7 +6,7 @@
 
 =over
 
-=item 1 Prebuilt package (TODO)
+=item 1 Prebuilt package
 
 =item 1 CPAN
 
@@ -28,37 +28,80 @@
 
 The final section deals with installation from the code repository. This will give you a bleeding edge version of Jifty. The developers work very hard at keeping this version in good working order, so if you really want the latest and the greatest, this is the best option. However, if you're getting started, we strongly recommend one of the previous options.
 
-=head2 Prebuilt Package (TODO)
+=head2 Prebuilt Package
 
-FIXME Someone needs to invent this package and then we can document it here...
+=for TODO Someone needs to invent this package and then we can document it here...
 
 =head2 CPAN
 
 Assuming you've got Perl (and CPAN) configured on your system already, installing Jifty is as simple as this:
 
-	% cpan Jifty
+  % cpan Jifty
 
 If you have it set up correctly, the CPAN program will take care of Jifty's many Perl dependencies for you.  Be patient - it'll take a while.  If you run into errors, try one of the other installation methods.
 
-TODO this should probably be more helpful.  "If you run into errors... sucks to be you" is the unspoken statement here.
+=for TODO this should probably be more helpful.  "If you run into errors... sucks to be you" is the unspoken statement here.
 
 =head2 Subversion
 
-If the CPAN method above didn't work for you, or you just have to have the latest Jifty release, you can check out the latest build from jifty.org's Subversion repository.  With Subversion installed, type:
+If you would like to take a shot at the latest features or need the latest bug fixes available to Jifty, you can build Jifty from the latest source code as well. To do this, you will need to first install Subversion. See L<http://subversion.tigris.org> for help with that process.
 
-	% svn co http://svn.jifty.org/svn/jifty.org/jifty/trunk/ jifty
+=for TODO Add a shameless plug for SVK.
 
-This will check out the latest trunk version of Jifty.  To browse other branches (which may be experimental, non-working, or both - you have been warned!), look through C<http://svn.jifty.org/svn/jifty.org/jifty/branches/>.
+=head3 Checking Out Jifty
 
-Note that Jifty requires M<Jifty::DBI>, and the repository version will often require a newer M<Jifty::DBI> than the one you might install via CPAN or another method.  To check out the latest version of Jifty::DBI, type:
+Once subversion is installed, you can fetch a copy of the latest Jifty source code by running this command:
 
-	% svn co http://svn.jifty.org/svn/jifty.org/Jifty-DBI/ jifty-dbi
-	% cd jifty-dbi
-	% perl Makefile.PL && make install
-	% cd ../jifty
-	% perl Makefile.PL && make install
+  % svn co http://svn.jifty.org/svn/jifty.org/jifty/trunk/ jifty
 
-If all tests pass properly, you should have a working Jifty installation!
+This will check out the latest trunk version of Jifty.N<If you're not familiar with version control terminology, the "trunk" just refers to the most important code repository. A "branch" is an offshoot, usually for trying out new ideas, adding features that would break the trunk, or just to do something different than the trunk.> 
+
+If you're interested in other branches of Jifty, you should probably take a look at the code available at U<http://svn.jifty.org/index.cgi/jifty/browse/jifty/branches> and contact the Jifty developers through the mailing list or IRC channels for more information. See A<hacking-jifty>.
+
+=for TODO Probably need to include some other libraries, such as Template::Declare here too...
+
+=head3 Installing Jifty::DBI
+
+Note that Jifty requires L<Jifty::DBI>, and the repository version will often require a newer L<Jifty::DBI> than the one you might install via CPAN or another method. To check out and install the latest version of Jifty::DBI, type:
+
+  % svn co http://svn.jifty.org/svn/jifty.org/Jifty-DBI/ jifty-dbi
+  % cd jifty-dbi
+  % perl Makefile.PL
+  % make
+  % make test
+  % make install
+
+This will fetch the most current trunk version of L<Jifty::DBI>, build the Makefile, build the documentation and prepare the code for testing and installation, test the code on your machine to make sure everything is working on your computer, and, finally, install the library.
+
+=head3 Installing Jifty
+
+=for TODO Describe how to deal with the multitudinous additional requirements that will probably need to be installed.
+
+Once L<Jifty::DBI> is installed, you can then install Jifty:
+
+  % cd ../jifty
+  % perl Makefile.PL
+  % make
+  % make test
+  % make install
+
+If all tests pass properly, you should have a working Jifty installation.
+
+=head2 What About Permissions?
+
+If you have permission issues during installation and do not know how to resolve them, you can try one of the following suggestions.
+
+=head3 Using Sudo
+
+If you have a problem installing L<Jifty::DBI> or L<Jifty> because of permission problems. You may need to run C<make install> as the administrator. On many systems, you can do this with the C<sudo> command, like so:
+
+  % sudo make install
+
+You will be asked for a password, which is your login password, and then it should install.
+
+=head3 Installing Locally
+
+=for TODO Describe installation using local installation directory and then configuring your environment to make it work.
 
 =head1 Testing
 


More information about the Jifty-commit mailing list