Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improving the README.md file with a more appealing look and bit more info #2065

Merged
merged 4 commits into from Mar 4, 2021

Conversation

valeriupredoi
Copy link
Contributor

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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@SarahAlidoost SarahAlidoost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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>
@valeriupredoi
Copy link
Contributor Author

@valeriupredoi looks great +1 . 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.

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 :)

@SarahAlidoost
Copy link
Contributor

@valeriupredoi looks great +1 . 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.

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:
Please see [getting started](https://docs.esmvaltool.org/en/latest/quickstart/index.html) on readthedocs as well as [ESMValTool tutorial](https://esmvalgroup.github.io/ESMValTool_Tutorial/index.html). The tutorial is a set of lessons that together teach skills needed to work with ESMValTool in climate-related domains.

@valeriupredoi
Copy link
Contributor Author

cheers @SarahAlidoost - added!

@valeriupredoi valeriupredoi merged commit e1f91af into master Mar 4, 2021
@valeriupredoi valeriupredoi deleted the improve_readme branch March 4, 2021 11:20
@valeriupredoi
Copy link
Contributor Author

cheers for the review @SarahAlidoost 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants