pg_readme

Generate a README.md document for a database extension or schema

Overview

ID	Extension	Package	Version	Category	License	Language
4300	pg_readme	pg_readme	`0.7.0`	UTIL	PostgreSQL	C

Attribute	Has Binary	Has Library	Need Load	Has DDL	Relocatable	Trusted
----dtr	No	No	No	Yes	yes	yes

Relationships
Requires	hstore
See Also	ddl_historization schedoc pg_render gzip bzip zstd http pg_net
Siblings	pg_readme_test_extension

Packages

Type	Repo	Version	PG Major Availability	Package Pattern	Dependencies
EL	PGDG	`0.7.0`	18 17 16 15 14 13	`pg_readme_$v`	-
Debian	PIGSTY	`0.7.0`	18 17 16 15 14 13	`postgresql-$v-pg-readme`	-

Linux / PG	PG18	PG17	PG16	PG15	PG14	PG13
el8.x86_64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
el8.aarch64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
el9.x86_64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
el9.aarch64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
el10.x86_64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
el10.aarch64	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0	PGDG 0.7.0
d12.x86_64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0
d12.aarch64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0
d13.x86_64	MISS	MISS	MISS	MISS	MISS	MISS
d13.aarch64	MISS	MISS	MISS	MISS	MISS	MISS
u22.x86_64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0
u22.aarch64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0
u24.x86_64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0
u24.aarch64	MISS	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0	PIGSTY 0.7.0

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_18`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_18-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_18`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_18-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_18`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_18-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_18`	0.7.0	`el9.aarch64`	pgdg	30.7 KiB	pg_readme_18-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_18`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_18-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_18`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_18-0.7.0-1PGDG.rhel10.noarch.rpm

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_17`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_17-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_17`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_17-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_17`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_17-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_17`	0.7.0	`el9.aarch64`	pgdg	30.8 KiB	pg_readme_17-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_17`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_17-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_17`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_17-0.7.0-1PGDG.rhel10.noarch.rpm
`postgresql-17-pg-readme`	0.7.0	`d12.x86_64`	pigsty	18.3 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~bookworm_amd64.deb
`postgresql-17-pg-readme`	0.7.0	`d12.aarch64`	pigsty	18.4 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~bookworm_arm64.deb
`postgresql-17-pg-readme`	0.7.0	`u22.x86_64`	pigsty	18.8 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~jammy_amd64.deb
`postgresql-17-pg-readme`	0.7.0	`u22.aarch64`	pigsty	18.8 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~jammy_arm64.deb
`postgresql-17-pg-readme`	0.7.0	`u24.x86_64`	pigsty	18.8 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~noble_amd64.deb
`postgresql-17-pg-readme`	0.7.0	`u24.aarch64`	pigsty	18.8 KiB	postgresql-17-pg-readme_0.7.0-1PIGSTY~noble_arm64.deb

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_16`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_16-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_16`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_16-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_16`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_16-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_16`	0.7.0	`el9.aarch64`	pgdg	30.8 KiB	pg_readme_16-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_16`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_16-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_16`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_16-0.7.0-1PGDG.rhel10.noarch.rpm
`postgresql-16-pg-readme`	0.7.0	`d12.x86_64`	pigsty	18.3 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~bookworm_amd64.deb
`postgresql-16-pg-readme`	0.7.0	`d12.aarch64`	pigsty	18.4 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~bookworm_arm64.deb
`postgresql-16-pg-readme`	0.7.0	`u22.x86_64`	pigsty	18.8 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~jammy_amd64.deb
`postgresql-16-pg-readme`	0.7.0	`u22.aarch64`	pigsty	18.8 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~jammy_arm64.deb
`postgresql-16-pg-readme`	0.7.0	`u24.x86_64`	pigsty	18.8 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~noble_amd64.deb
`postgresql-16-pg-readme`	0.7.0	`u24.aarch64`	pigsty	18.8 KiB	postgresql-16-pg-readme_0.7.0-1PIGSTY~noble_arm64.deb

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_15`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_15-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_15`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_15-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_15`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_15-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_15`	0.7.0	`el9.aarch64`	pgdg	30.8 KiB	pg_readme_15-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_15`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_15-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_15`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_15-0.7.0-1PGDG.rhel10.noarch.rpm
`postgresql-15-pg-readme`	0.7.0	`d12.x86_64`	pigsty	18.4 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~bookworm_amd64.deb
`postgresql-15-pg-readme`	0.7.0	`d12.aarch64`	pigsty	18.4 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~bookworm_arm64.deb
`postgresql-15-pg-readme`	0.7.0	`u22.x86_64`	pigsty	18.8 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~jammy_amd64.deb
`postgresql-15-pg-readme`	0.7.0	`u22.aarch64`	pigsty	18.8 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~jammy_arm64.deb
`postgresql-15-pg-readme`	0.7.0	`u24.x86_64`	pigsty	18.8 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~noble_amd64.deb
`postgresql-15-pg-readme`	0.7.0	`u24.aarch64`	pigsty	18.8 KiB	postgresql-15-pg-readme_0.7.0-1PIGSTY~noble_arm64.deb

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_14`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_14-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_14`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_14-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_14`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_14-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_14`	0.7.0	`el9.aarch64`	pgdg	30.8 KiB	pg_readme_14-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_14`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_14-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_14`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_14-0.7.0-1PGDG.rhel10.noarch.rpm
`postgresql-14-pg-readme`	0.7.0	`d12.x86_64`	pigsty	18.4 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~bookworm_amd64.deb
`postgresql-14-pg-readme`	0.7.0	`d12.aarch64`	pigsty	18.4 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~bookworm_arm64.deb
`postgresql-14-pg-readme`	0.7.0	`u22.x86_64`	pigsty	18.8 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~jammy_amd64.deb
`postgresql-14-pg-readme`	0.7.0	`u22.aarch64`	pigsty	18.7 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~jammy_arm64.deb
`postgresql-14-pg-readme`	0.7.0	`u24.x86_64`	pigsty	18.8 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~noble_amd64.deb
`postgresql-14-pg-readme`	0.7.0	`u24.aarch64`	pigsty	18.8 KiB	postgresql-14-pg-readme_0.7.0-1PIGSTY~noble_arm64.deb

Package	Version	OS	ORG	SIZE	File URL
`pg_readme_13`	0.7.0	`el8.x86_64`	pgdg	31.5 KiB	pg_readme_13-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_13`	0.7.0	`el8.aarch64`	pgdg	31.5 KiB	pg_readme_13-0.7.0-1PGDG.rhel8.noarch.rpm
`pg_readme_13`	0.7.0	`el9.x86_64`	pgdg	30.8 KiB	pg_readme_13-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_13`	0.7.0	`el9.aarch64`	pgdg	30.8 KiB	pg_readme_13-0.7.0-1PGDG.rhel9.noarch.rpm
`pg_readme_13`	0.7.0	`el10.x86_64`	pgdg	31.4 KiB	pg_readme_13-0.7.0-1PGDG.rhel10.noarch.rpm
`pg_readme_13`	0.7.0	`el10.aarch64`	pgdg	31.3 KiB	pg_readme_13-0.7.0-1PGDG.rhel10.noarch.rpm
`postgresql-13-pg-readme`	0.7.0	`d12.x86_64`	pigsty	18.4 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~bookworm_amd64.deb
`postgresql-13-pg-readme`	0.7.0	`d12.aarch64`	pigsty	18.3 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~bookworm_arm64.deb
`postgresql-13-pg-readme`	0.7.0	`u22.x86_64`	pigsty	18.8 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~jammy_amd64.deb
`postgresql-13-pg-readme`	0.7.0	`u22.aarch64`	pigsty	18.8 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~jammy_arm64.deb
`postgresql-13-pg-readme`	0.7.0	`u24.x86_64`	pigsty	18.8 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~noble_amd64.deb
`postgresql-13-pg-readme`	0.7.0	`u24.aarch64`	pigsty	18.8 KiB	postgresql-13-pg-readme_0.7.0-1PIGSTY~noble_arm64.deb

Source

Repository

github.com/bigsmoke/pg_readme

Source Tarball

pg_readme-0.7.0.tar.gz

pig build get pg_readme; # get pg_readme source code
pig build dep pg_readme; # install build dependencies
pig build pkg pg_readme; # build extension rpm or deb
pig build ext pg_readme; # build extension rpms

Install

To add the required PGDG / PIGSTY upstream repository, use:

pig repo add pgsql -u   # add PGDG + Pigsty repo and update cache (leave existing repos)

Install this extension with:

pig ext install pg_readme; # install by extension name, for the current active PG version
pig ext install pg_readme; # install via package alias, for the active PG version
pig ext install pg_readme -v 18;   # install for PG 18
pig ext install pg_readme -v 17;   # install for PG 17
pig ext install pg_readme -v 16;   # install for PG 16
pig ext install pg_readme -v 15;   # install for PG 15
pig ext install pg_readme -v 14;   # install for PG 14
pig ext install pg_readme -v 13;   # install for PG 13

Create this extension with:

CREATE EXTENSION pg_readme;

Last updated on 2025-11-02

pg_render pg_readme_test_extension