[8ed06c]: 00README.pod  Maximize  Restore  History

Download this file

72 lines (49 with data), 2.2 kB

=for comment
Read this 00README.pod with:
perldoc -F 00README.pod
...but the html is a prettier version with:
pod2html --infile=00README.pod --outfile=00README.html --noindex

=head1 Using C<git> to access the PDL Book

The Book source is in POD format and can be read online in the git
repository at:

    http://pdl.git.sourceforge.net/git/gitweb.cgi?p=pdl/pdl-book;a=tree

To get a local copy on your computer, use:

    git clone ssh://pdl.git.sourceforge.net/gitroot/pdl/pdl-book

=head2 Making a PDF from the POD - Installing C<pod2pdf>

To make the PDF files, you need to install the Perl modules
C<Image::Size>, C<File::Type> and finally C<pod2pdf>. I use the C<CPAN>
shell:

    sudo cpan
    install Image::Size
    install File::Type
    install App:pod2pdf

All images are included in the PODs as HTML tags. A small script
can convert these tags into PDF tags suitable for C<pod2pdf>.

If you want to make the HTML and PDF versions of the book, you can then
run:

    ./make_book.pl

=head1 Adding new material and getting write access to the PDL Book

You need to have a sourceforge account, and be authorised by one of the
PDL gurus to have access to this repository. When you have both of these
things, clone this URL:

    git clone ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
    git clone ssh://kenworthy@pdl.git.sourceforge.net/gitroot/pdl/pdl-book

where USERNAME is your sf.net username. When you've downloaded it, do:

    cd pdl-book
    <edit files and make modifications>
    git add <file>

Check with:

    git status
    git commit . # this stages your file and readies it for the push
    git status # check one more time....
    git push # send it off to the master origin repo

To update your local repository and working copy to the latest revision
committed to the remote repository, you need to execute C<git pull>.
This
pulls all of the changesets down from the remote repository and merges
them with your current changes (if there are any).

To delete a file from the repository (careful there, Ted) you do a:

    git rm --cached <file>
    git commit <file>
    git push

You can wait on the git push for other changes in your current session.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks