Document how to use in your own Pyramid application
authorKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 15:21:54 +0000 (09:21 -0600)
committerKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 15:21:54 +0000 (09:21 -0600)
README.rst

index c573c592e13f512f2007cc8fa04fd69b223c33da..d243c57e3578dd236df071298307bf4528dbbce1 100644 (file)
@@ -41,10 +41,21 @@ discovering and reporting as many errors as is possible per bulk
 interaction with the database.
 
 
+Usage
+-----
+
+When utilizing PGWUI modules in your own `Pyramid`_ application,
+modules which require the PGWUI_Common module, PGWUI_Common must be
+explicitly configured.  This can be done with any of `Pyramid's
+<Pyramid_>`_ configuration mechanisms, ``pyramid_includes =
+pgwui_common`` in a ``.ini`` file or
+``config.include('pgwui_common')`` in Python code.
+
+
 Configuration By Python Code
 ----------------------------
 
-If you are writing a complete Pyramid application, or simply want full
+If you are writing a complete `Pyramid`_ application, or simply want full
 control over configuration you will need to make a Python
 distribution.  (Something to be installed, perhaps with ``pip``.)
 In this case use pgwui_common to configure your pyramid app by putting