Re: An improved README experience for PostgreSQL

From: Nathan Bossart <nathandbossart(at)gmail(dot)com>
To: Andrew Atkinson <andyatkinson(at)gmail(dot)com>
Cc: pgsql-hackers(at)postgresql(dot)org, samay(at)tembo(dot)io
Subject: Re: An improved README experience for PostgreSQL
Date: 2024-02-26 18:30:18
Message-ID: 20240226183018.GA2109010@nathanxps13
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Mon, Feb 26, 2024 at 11:31:19AM -0600, Andrew Atkinson wrote:
> Hello Hackers. We’re proposing an improved README for PostgreSQL that
> includes more helpful links for prospective PostgreSQL contributors and has
> a nicer presentation.
>
> Although development does not take place on GitHub or GitLab for
> PostgreSQL, many developers might view the PostgreSQL source code using one
> of those mirrors (I do myself). Since both support Markdown files, a
> Markdown version of the README (as README.md) gets presentational benefits
> that I think are helpful.

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.

--
Nathan Bossart
Amazon Web Services: https://aws.amazon.com

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Jacob Champion 2024-02-26 18:56:39 Re: Refactor SASL exchange in preparation for OAuth Bearer
Previous Message Amonson, Paul D 2024-02-26 17:56:50 RE: Popcount optimization using AVX512