theory / pgtap

PostgreSQL Unit Testing Suite
https://pgtap.org
984 stars 92 forks source link

Misleading Installation Instructions #301

Closed machineghost closed 1 year ago

machineghost commented 1 year ago

The instructions on https://pgtap.org/documentation.html#installation say:

To install pgTAP into a PostgreSQL database, just do this:

make
make install
make installcheck

Shouldn't that say:

To install pgTAP, first download the source code from _someurl. Then, run the following commands at the command line, from inside the folder where you downloaded pgTAP:

make
make install
make installcheck

P.S. And of course, I realize that using make should already be second nature for a C dev. But ... C devs aren't the only ones using PostgreSQL. Developers coming from interpreted language backgrounds need you to spell things out more.

P.P.S. On Linux installing pgTAP is as simple as:

sudo apt-get install pgtap

It would seem like that's worth noting in the documentation also.

theory commented 1 year ago

Well that's generated from doc/pgtap.mmd, which ships with the source code. Would not object to adding additional wording or links to binary installers, though, if you wanted to make a pull request.

theory commented 1 year ago

Did you want to submit a PR for the, @machineghost?

machineghost commented 1 year ago

My apologies; somehow this fell off my radar :(

theory commented 1 year ago

no worries, I cribbed from your draft :-)