On Wed, Feb 28, 2024 at 01:54:59PM -0500, David E. Wheeler wrote: > On Feb 28, 2024, at 1:51 PM, Alvaro Herrera <alvhe...@alvh.no-ip.org> wrote: >> *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. > > Markdown++ > > IME the keys to decent-looking Markdown are: > > 1. Wrapping lines to a legible width (76-80 chars) > 2. Link references rather than inline links > > I try to follow these for my blog; posts end up looking like this: > > https://justatheory.com/2024/02/extension-metadata-typology.text > > (Append `.text` to any post to see the raw(ish) Markdown.
Here is what converting the current README to Markdown with no other content changes might look like. -- Nathan Bossart Amazon Web Services: https://aws.amazon.com
>From 5d618e3c0e33854d1afe7230b0ca6ad8f0177996 Mon Sep 17 00:00:00 2001 From: Nathan Bossart <nat...@postgresql.org> Date: Wed, 28 Feb 2024 13:05:39 -0600 Subject: [PATCH 1/1] Convert README to Markdown. --- README => README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) rename README => README.md (68%) diff --git a/README b/README.md similarity index 68% rename from README rename to README.md index e40e610ccb..dfdf7415a5 100644 --- a/README +++ b/README.md @@ -1,5 +1,4 @@ -PostgreSQL Database Management System -===================================== +# PostgreSQL Database Management System This directory contains the source code distribution of the PostgreSQL database management system. @@ -12,11 +11,11 @@ and functions. This distribution also contains C language bindings. Copyright and license information can be found in the file COPYRIGHT. General documentation about this version of PostgreSQL can be found at: -https://www.postgresql.org/docs/devel/ +<https://www.postgresql.org/docs/devel/> In particular, information about building PostgreSQL from the source code can be found at: -https://www.postgresql.org/docs/devel/installation.html +<https://www.postgresql.org/docs/devel/installation.html> The latest version of this software, and related software, may be -obtained at https://www.postgresql.org/download/. For more information -look at our web site located at https://www.postgresql.org/. +obtained at <https://www.postgresql.org/download/>. For more information +look at our web site located at <https://www.postgresql.org/>. -- 2.25.1
