Skip to content

add releases and building info to README.md

David Keitel requested to merge readme-build into master

Description

@adam-mercer @duncanmmacleod this adds two items to the main README:

  1. links to releases at the top
  2. "Building from Source" section, recommending conda for this task, as I assume you'd like people to use nowadays.

Please feel free to amend wording and add anything I may have forgotten.

Maybe Duncan could also add a sentence about the install scripts included in the conda directory, if these are intended to be part of the standard workflow? I haven't used them yet.

API Changes and Justification

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status


Merge request reports