Re: An improved README experience for PostgreSQL - Mailing list pgsql-hackers

From Daniel Gustafsson
Subject Re: An improved README experience for PostgreSQL
Date
Msg-id DAB16F23-BE05-44E3-80DB-8D60961B8906@yesql.se
Whole thread Raw
In response to Re: An improved README experience for PostgreSQL  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: An improved README experience for PostgreSQL
List pgsql-hackers
> On 26 Feb 2024, at 21:30, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>
> Nathan Bossart <nathandbossart@gmail.com> writes:
>> I think this would be nice.  If the Markdown version is reasonably readable
>> as plain-text, maybe we could avoid maintaining two READMEs files, too.
>> But overall, +1 to modernizing the README a bit.
>
> Per past track record, we change the top-level README only once every
> three years or so, so I doubt it'd be too painful to maintain two
> versions of it.

It wont be, and we kind of already have two since there is another similar
README displayed at https://www.postgresql.org/ftp/.  That being said, a
majority of those reading the README will likely be new developers accustomed
to Markdown (or doing so via interfaces such as Github) so going to Markdown
might not be a bad idea.  We can also render a plain text version with pandoc
for release builds should we want to.

--
Daniel Gustafsson




pgsql-hackers by date:

Previous
From: Alexander Pyhalov
Date:
Subject: Re: Partial aggregates pushdown
Next
From: Jacob Champion
Date:
Subject: Re: [PoC] Federated Authn/z with OAUTHBEARER