summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKurt Jung <kurt.w.jung@gmail.com>2015-08-26 20:44:07 -0400
committerKurt Jung <kurt.w.jung@gmail.com>2015-08-26 20:44:07 -0400
commit18c33c52f49afda63dabe7952b0ed98de6aead3a (patch)
treebccaf58af2d87d6f075a6b0388e6eee534018d8d /README.md
parente3a6324d33873b0347a190bfb82d7d04315c1c85 (diff)
Factor various test example helper routines into their own internal package
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index afe108f..4feb48a 100644
--- a/README.md
+++ b/README.md
@@ -93,8 +93,9 @@ rather than PHP.
##Example PDFs
-A side effect of running "go test" is the production of a number of example
-PDFs. These can be found in the gofpdf/pdf directory after the tests complete.
+A side effect of running "go test ./..." is the production of a number of
+example PDFs. These can be found in the gofpdf/pdf directory after the tests
+complete.
Please note that these examples run in the context of a test. In order run an
example as a standalone application, you'll need to examine [fpdf_test.go](https://github.com/jung-kurt/gofpdf/blob/master/fpdf_test.go) for
@@ -135,8 +136,11 @@ gofpdf for its document production mode.
gofpdf is a global community effort and you are invited to make it even better.
If you have implemented a new feature or corrected a problem, please consider
-contributing your change to the project. Here are guidelines for making
-submissions. Your change should
+contributing your change to the project. Contributions that do not directly
+pertain to the core functionality of gofpdf should be placed in their own
+directory directly beneath the `contrib` directory.
+
+Here are guidelines for making submissions. Your change should
* be compatible with the MIT License
* be properly documented