Reformat README based on markdownlint suggestions

Fix broken cross-section links. Reformat based on suggestions
from vscode markdownlint suggestions: clearer annotations for block
codes and better spacing. Also fix some typos.

Author: Toefinder