Skip to content

Add README explaining purpose of include/ directory

Duncan Macleod requested to merge duncanmmacleod/lalsuite:include-readme into master

Description

This MR adds a README.md file each of the include/ and include/lal/ directories for all of the subpackages that explains why that directory is there and how it is used.

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

@karl-wette should review to make sure the text of the README file is actually true.

Merge request reports