Iris readme minimal #3833
Merged
Iris readme minimal #3833
Conversation
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
* master: Fix sphinx logger (SciTools#3832) whatsnew entry for dependencies (SciTools#3831) Added link to scitools.org.uk on the main index. (SciTools#3830)
|
A separate PR will be created to update the Iris headline on https://scitools.org.uk/ |
|
@tkknight Lovely, akin to the dask README.md. Minimalist works for me. Particularly as I'm keen that we don't have the same information in multiple places, otherwise it's a maintenance overhead... with the high potential to go stale or out of sync. I like the one stop shop approach to directing everyone to the documentation instead. Makes total sense to me 👍 Also, the License is highlighted by GitHub in the |
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 11, 2020
* master: Rework whatsnew into new scheme. (SciTools#3834) Lazy regridding with Linear, Nearest, and AreaWeighted (SciTools#3701) Iris readme minimal (SciTools#3833)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Sep 11, 2020
* master: (36 commits) Rework whatsnew into new scheme. (SciTools#3834) Lazy regridding with Linear, Nearest, and AreaWeighted (SciTools#3701) Iris readme minimal (SciTools#3833) Fix sphinx logger (SciTools#3832) whatsnew entry for dependencies (SciTools#3831) Added link to scitools.org.uk on the main index. (SciTools#3830) Updated Iris install instructions (SciTools#3817) Delete labeler.yml Delete label.yml Create label.yml Delete labeler.yml Update labeler.yml Update labeler.yml Add template collapsible markdown section (SciTools#3823) Requirements re-haul (SciTools#3812) Automate pull request labels (SciTools#3819) move whatsnew contributions (SciTools#3816) Parse with packaging version (SciTools#3815) Add "What's New" entries for unpinning Cartopy, Matplotlib, Proj (SciTools#3811) tidy issue templates (SciTools#3814) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The Iris README.md that is displayed on the GitHub landing page https://github.com/SciTools/iris has been pruned down to the minimal needed. That being the logo, some badges, the headline description of Iris and a link to the documentation.
This minimal approach removes some duplication to make it easier to manage.
Also updated the headline for Iris to be Python package instead of Python library