summaryrefslogtreecommitdiffstats
path: root/contrib/README
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/README')
-rw-r--r--contrib/README28
1 files changed, 28 insertions, 0 deletions
diff --git a/contrib/README b/contrib/README
new file mode 100644
index 0000000..5eaeb24
--- /dev/null
+++ b/contrib/README
@@ -0,0 +1,28 @@
+The PostgreSQL contrib tree
+---------------------------
+
+This subtree contains porting tools, analysis utilities, and plug-in
+features that are not part of the core PostgreSQL system, mainly
+because they address a limited audience or are too experimental to be
+part of the main source tree. This does not preclude their
+usefulness.
+
+User documentation for each module appears in the main SGML
+documentation.
+
+When building from the source distribution, these modules are not
+built automatically, unless you build the "world" target. You can
+also build and install them all by running "make all" and "make
+install" in this directory; or to build and install just one selected
+module, do the same in that module's subdirectory.
+
+Some directories supply new user-defined functions, operators, or
+types. To make use of one of these modules, after you have installed
+the code you need to register the new SQL objects in the database
+system by executing a CREATE EXTENSION command. In a fresh database,
+you can simply do
+
+ CREATE EXTENSION module_name;
+
+See the PostgreSQL documentation for more information about this
+procedure.