Skip to content

Installation docs need summary, updating

The installation docs on the wiki are in need of a refresh.

  1. A package summary in the Prerequisites section
  2. Streamline Linux and Mac sections to point the prerequisites list.
  3. Update Windows section

For the prerequisites summary I'm imagining something like the Prerequsites section in the Tutorial Getting Started topic, but with one more piece of information:


Prerequisites

Required

Purpose Package Minimum Version
Download git, tar
Compiler gcc
clang
≥ 8
Configuration python3
cmake, and at least one of
make, ninja, XCode
≥3.6
≥ 3.10

Optional

Feature Package
Faster compilation ccache
Visualizer cppyy
netanim qt5
Parallel execution MPI: openmpi, mpich, mvapich
...

The Linux and Mac sections could be greatly streamlined by referring the Prerequisites tables. They would only have to summarize the basic form to install packages using apt, dnf, port, brew, pip3...

In addition, there are still references to waf and mercurial, and it looks the Windows section is completely out of date.