Date: Mon, 26 Feb 2024 12:30:18 -0600
From: Nathan Bossart <nathandbossart@gmail.com>
To: Andrew Atkinson <andyatkinson@gmail.com>
Cc: pgsql-hackers@postgresql.org, samay@tembo.io
Subject: Re: An improved README experience for PostgreSQL
Message-ID: <20240226183018.GA2109010@nathanxps13>
References: <CAG6XLEmGE95DdKqjk+Dd9vC8mfN7BnV2WFgYk_9ovW6ikN0YSg@mail.gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <CAG6XLEmGE95DdKqjk+Dd9vC8mfN7BnV2WFgYk_9ovW6ikN0YSg@mail.gmail.com>
Archived-At: <https://www.postgresql.org/message-id/20240226183018.GA2109010%40nathanxps13>
Precedence: bulk

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