Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 82 lines (51 sloc) 2.534 kb
81b40de @leto Start the 'Test Driven Enlightenment' book from a skeleton of 'Modern Pe...
authored
1 # Test Driven Enlightenment
2
3 # Intended Audience
4
37a99da @leto Improve readme
authored
5 Anybody who wants to learn more about testing software to improve its awesomeness.
6
81b40de @leto Start the 'Test Driven Enlightenment' book from a skeleton of 'Modern Pe...
authored
7 # Reviewer Guidelines
8
9 I appreciate all suggestions and critiques, especially:
10
37a99da @leto Improve readme
authored
11 * Is the work accurate?
12 * Is the work complete?
13 * Is the work coherent?
14 * Are there missing sections and subjects?
15 * Are the examples effective?
16 * Is the flow of information appropriate?
81b40de @leto Start the 'Test Driven Enlightenment' book from a skeleton of 'Modern Pe...
authored
17
18 # Building this Book
19
20 You need a modern version of Perl installed. I recommend Perl 5.10.1, but
21 anything newer than 5.8.6 should work.
22
23 You should also have Pod::PseudoPod 0.16 or newer installed with its
24 dependencies.
25
26 From the top level directory of a checkout, build the individual chapters with:
27
28 $ perl build/tools/build_chapters.pl
29
30 The chapter sources are in the sections/ directory. Each chapter has a
31 corresponding chapter_nn.pod file. Each file contains multiple POD links which
32 refer to other files in the sections/ directory. Each of those files contains
33 a PseudoPOD Z<> anchor.
34
35 The build_chapters.pl program weaves these sections into chapters and writes
36 them to POD files in build/chapters.
37
38 (This process makes it easy to rearrange sections within and between chapters
39 without generating huge diffs.)
40
41 To build HTML from these woven chapters:
42
43 $ perl build/tools/build_html.pl
44
45 This will produce nicely-formatted HTML in the build/html/ directory. If
46 anything looks wrong, it's a mistake on my part (or a CSS problem) and patches
47 are very welcome.
48
49 To build an ePub eBook from the woven chapters:
50
51 $ perl build/tools/build_epub.pl
52
53 This will produce an ePub eBook in the build/epub/ directory.
54
55 To build PDFs from the chapters:
56
57 $ perl build/tools/build_pdf.pl
58
59 This will build PDFs in the build/pdf directory. You must have App::pod2pdf
60 installed from the CPAN.
61
62
63 # Contributing to Test Drive Enlightenment
64
65 This work is licensed under a Creative Commons Attribution-Noncommercial-Share
66 Alike 3.0 United States License. For more details, see:
67
68 http://creativecommons.org/licenses/by-nc-sa/3.0/us/
69
70 Please feel free to point people to this repository. Suggestions and
71 contributions are welcome. You have the right to redistribute modified
72 versions, but I ask (though do not require) you to file bugs or submit pull
73 requests against this repository.
74
75 This book is available in print and in formatted electronic formats
76 from Onyx Neon Press:
77
78 http://www.onyxneon.com/books/REAL_SOON_NOW
79
80 The electronic versions are available for free, with no restrictions on free
81 redistribution.
Something went wrong with that request. Please try again.