Skip to content

Add a table of content to the README file

Alexandre Blondin Massé requested to merge readme-toc into master

Since the README file is becoming increasingly larger, it seems convenient to add a table of contents. This MR intends to do so.

I also brought some minor changes:

  • There was a duplicate Prerequisites section at the end. I deleted it.
  • I renamed the subcommand subsection titles with the explicit subcommand
  • I used a Vim plugin to generate the table of contents (TOC) automatically. It adds tags before and after the TOC to make it easier to update it.
Edited by Alexandre Blondin Massé

Merge request reports