Harmonise README + clean LICENSE clause#8
Merged
Conversation
Citation request lives in CITATION.cff and README.md; the LICENSE file should reflect the SPDX license declared in pyproject.toml and CITATION.cff (Apache-2.0) without modification.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Part of the cross-repo README harmonisation pass (Pass F), plus a LICENSE cleanup.
Two commits on this branch:
Harmonise README — full rewrite. The old README (31 lines) was MATLAB-only and made no mention of the
dcebePyPI package despite the package living in this same repo.estimate_batPORTED_BY.mdDrop non-standard citation clause from LICENSE — the LICENSE file added "if this code is used in any scientific publication, the following paper shall be cited" on top of Apache-2.0. The CITATION.cff and pyproject.toml both declare pure
Apache-2.0. Citation request stays in CITATION.cff and README; LICENSE now matches the SPDX expression declared elsewhere in the repo.Test plan
from dcebe import estimate_bat)