Re: An improved README experience for PostgreSQL

Daniel Gustafsson <daniel@yesql.se>

From: Daniel Gustafsson <daniel@yesql.se>

To: Alvaro Herrera <alvherre@alvh.no-ip.org>

Cc: Joe Conway <mail@joeconway.com>, Nathan Bossart <nathandbossart@gmail.com>, Tom Lane <tgl@sss.pgh.pa.us>, Andrew Atkinson <andyatkinson@gmail.com>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, samay@tembo.io

Date: 2024-02-28T19:07:30Z

Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.
- dec9d4acdb7d 18.0 landed
Revise the style of a paragraph in README.md.
- 84d80663199b 17.0 landed
Convert README to Markdown.
- 363eb059966d 17.0 landed

> On 28 Feb 2024, at 19:51, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
> 
> On 2024-Feb-28, Joe Conway wrote:
> 
>> Markdown is pretty readable as text, I'm not sure why we need both.
> 
> *IF* people don't go overboard, yes.  I agree, but let's keep an eye so
> that it doesn't become an unreadable mess.  I've seen some really
> horrible markdown files that I'm sure most of you would object to.

Absolutely, I agree. Considering the lengths we go to to keep our code readable I’m not worried, I expect that a markdown README would end up pretty close to the txt version we have today.

./daniel