summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@code.google.com>2014-08-25 17:11:35 -0400
committerKurt Jung <kurt.w.jung@code.google.com>2014-08-25 17:11:35 -0400
commit9f16b52334238f446dbafcbe06ffff0637403361 (patch)
treec33be9fcac91748f8049134b20abc3b0d41248ba /doc.go
parentedb1e32a7b9a4547c3851294e58f76dc3188f6a1 (diff)
Additional comment about tutorials
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc.go b/doc.go
index d62a20d..0a394a4 100644
--- a/doc.go
+++ b/doc.go
@@ -135,6 +135,13 @@ Tutorials
A side effect of running "go test" is the production of the tutorial PDFs.
These can be found in the gofpdf/pdf directory after the tests complete.
+Please note that these tutorials run in the context of a test. In order run an
+example as a standalone application, you'll need to examine fpdf_test.go for
+some helper routines, for example docWriter and strDelimit. In particular,
+docWriter is used as an argument to OutputAndClose in order to reduce the
+boilerplate in each example. In practice, you may be better served by calling
+OutputFileAndClose().
+
Nonstandard Fonts
Nothing special is required to use the standard PDF fonts (courier, helvetica,