Diff of /00README.pod [0b48cc] .. [8ed06c] Maximize Restore

  Switch to unified view

a/00README.pod b/00README.pod
...
...
9
The Book source is in POD format and can be read online in the git
9
The Book source is in POD format and can be read online in the git
10
repository at:
10
repository at:
11
11
12
    http://pdl.git.sourceforge.net/git/gitweb.cgi?p=pdl/pdl-book;a=tree
12
    http://pdl.git.sourceforge.net/git/gitweb.cgi?p=pdl/pdl-book;a=tree
13
13
14
If you want to make the HTML and PDF versions of the book, you can 
14
To get a local copy on your computer, use:
15
15
16
    git clone ssh://anonymous@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
16
    git clone ssh://pdl.git.sourceforge.net/gitroot/pdl/pdl-book
17
18
=head2 Making a PDF from the POD - Installing C<pod2pdf>
19
20
To make the PDF files, you need to install the Perl modules
21
C<Image::Size>, C<File::Type> and finally C<pod2pdf>. I use the C<CPAN>
22
shell:
23
24
    sudo cpan
25
    install Image::Size
26
    install File::Type
27
    install App:pod2pdf
28
29
All images are included in the PODs as HTML tags. A small script
30
can convert these tags into PDF tags suitable for C<pod2pdf>.
31
32
If you want to make the HTML and PDF versions of the book, you can then
33
run:
34
35
    ./make_book.pl
17
36
18
=head1 Adding new material and getting write access to the PDL Book
37
=head1 Adding new material and getting write access to the PDL Book
19
38
20
You need to have a sourceforge account, and be authorised by one of the
39
You need to have a sourceforge account, and be authorised by one of the
21
PDL gurus to have access to this repository. When you have both of these
40
PDL gurus to have access to this repository. When you have both of these
22
things, clone this URL:
41
things, clone this URL:
23
42
24
    git clone ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
43
    git clone ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
25
    git clone ssh://kenworthy@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
44
    git clone ssh://kenworthy@pdl.git.sourceforge.net/gitroot/pdl/pdl-book
26
45
27
where USERNAME is your sf.net username, or use C<anonymous> as a
46
where USERNAME is your sf.net username. When you've downloaded it, do:
28
USERNAME. When you've downloaded it, do:
29
47
30
    cd pdl-book
48
    cd pdl-book
31
    <edit files and make modifications>
49
    <edit files and make modifications>
32
    git add <file>
50
    git add <file>
33
51
...
...
49
    git rm --cached <file>
67
    git rm --cached <file>
50
    git commit <file>
68
    git commit <file>
51
    git push
69
    git push
52
70
53
You can wait on the git push for other changes in your current session.
71
You can wait on the git push for other changes in your current session.
54
55
=head1 Making a PDF from the POD - Installing C<pod2pdf>
56
57
To make the PDF files, you need to install the Perl modules
58
C<Image::Size>, C<File::Type> and finally C<pod2pdf>. I use the C<CPAN>
59
shell myself:
60
61
    sudo cpan
62
    install Image::Size
63
    install File::Type
64
    install App:pod2pdf
65
66
All images are included in the PODs as HTML tags. A small script
67
can convert these tags into PDF tags suitable for C<pod2pdf>.
68