improving the README.md file with a more appealing look and bit more info#2065
improving the README.md file with a more appealing look and bit more info#2065valeriupredoi merged 4 commits intomasterfrom
Conversation
README.md
Outdated
| will be subject to, and directives for the actual diagnostics that will be run with the now preprocessed data. | ||
| Data preprocessing is done via the [ESMValCore](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/index.html) package, a pure Python, highly-optimized scientific library, developed by the ESMValTool core developers, | ||
| and that performs a number of common analysis tasks | ||
| such as regridding, masking, levels extraction etc. [Diagnostics](https://docs.esmvaltool.org/en/latest/develop/diagnostic.html) are written in a variety of programming languages (Python, NCL, R, julia) and are developed by the wider |
There was a problem hiding this comment.
IMHO, Julia starts with the upper-case letter J, as it is written in its documentation e.g. "Welcome to the documentation for Julia 1.5.". I might miss something here so please feel free to ignore my comment.
SarahAlidoost
left a comment
SarahAlidoost
left a comment
There was a problem hiding this comment.
@valeriupredoi looks great 👍 . I just added two minor comments. It would be great if we can also add a sentence about the tutorial in the section "Getting started". Thank you.
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
Cheers @SarahAlidoost - would you be able to do that please (here)? It's your baby and I want it done good justice, instead of me adding some terse line :) |
Sure, I couldn't add it to this PR, because that line wasn't changed. Here my suggestion for revising the line in that section: |
|
cheers @SarahAlidoost - added! |
|
cheers for the review @SarahAlidoost 👍 |
2 participants
The README file is oftentimes the first entry point for new users, we should be a bit nicer and give people a bit more info and definitely more pointers to resources