Skip to content

Commit b0e1f00

Browse files
committed
update the content of readme
1 parent 4be8dc7 commit b0e1f00

File tree

1 file changed

+29
-33
lines changed

1 file changed

+29
-33
lines changed

README.md

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,47 @@
1-
# FIXME Lesson title
1+
# ESMValTool Tutorial
22

3-
[![Create a Slack Account with
4-
us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/)
53
[![Join the chat at
64
https://gitter.im/ESMValGroup/Tutorial](https://badges.gitter.im/ESMValGroup/Tutorial.svg)](https://gitter.im/ESMValGroup/Tutorial?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
75

8-
This repository generates the corresponding lesson website from [The
9-
Carpentries](https://carpentries.org/) repertoire of lessons.
6+
[ESMValTool Tutorial][tutorial-site] is an open-source project in
7+
[ESMValGroup][ESMValTool-site].
8+
This tutorial is a set of lessons that together teach skills needed to work
9+
with ESMValTool in climate-related domains.
10+
The Earth System Model Evaluation Tool ([ESMValTool][ESMValTool-site]) is a
11+
community diagnostics and performance metrics tool for the evaluation of
12+
Earth System Models (ESMs) that allows for routine comparison of single or
13+
multiple models.
1014

1115
## Contributing
1216

13-
We welcome all contributions to improve the lesson! Maintainers will do their
14-
best to help you if you have any questions, concerns, or experience any
15-
difficulties along the way.
16-
17-
We'd like to ask you to familiarize yourself with our [Contribution
18-
Guide](CONTRIBUTING.md) and have a look at the [more detailed
19-
guidelines][lesson-example] on proper formatting, ways to render the lesson
20-
locally, and even how to write new episodes. Note that the content of the web
21-
page is located in the directory
22-
[_episodes](https://github.com/ESMValGroup/tutorial/tree/master/_episodes).
23-
24-
Please see the current list of [issues][FIXME] for ideas for contributing to
25-
this repository. For making your contribution, we use the GitHub flow, which is
26-
nicely explained in the chapter [Contributing to a
27-
Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro
28-
Git by Scott Chacon. Look for the tag
29-
![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg).
30-
This indicates that the maintainers will welcome a pull request fixing this
31-
issue.
32-
17+
We welcome all contributions to improve the lesson!
18+
We'd like to ask you to familiarize yourself with our guide in
19+
[CONTRIBUTING](CONTRIBUTING) and our [Code of Conduct](CODE_OF_CONDUCT).
3320

3421
## Maintainer(s)
3522

36-
Current maintainers of this lesson are
37-
38-
* FIXME
39-
* FIXME
40-
* FIXME
23+
Current maintainers of this tutorial are ESMValTool
24+
[User Engagement Team][user-engagement].
25+
Maintainers will do their
26+
best to help you if you have any questions, concerns, or experience any
27+
difficulties along the way.
4128

29+
If you work or study in climate-related domains and would be interested in
30+
getting involved, you can reach us by email.
31+
Please see the [contact information][contact-info].
4232

4333
## Authors
4434

45-
A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
35+
A list of contributors to the lesson can be found in [AUTHORS](AUTHORS).
4636

4737
## Citation
4838

49-
To cite this lesson, please consult with [CITATION](CITATION)
39+
To cite this Tutorial, please consult with [CITATION](CITATION).
5040

51-
[lesson-example]: https://carpentries.github.io/lesson-example
41+
[email]: mailto:TODO_FIX_ME
42+
[ESMValTool-site]: https://www.esmvaltool.org/
43+
[ESMValTool-doc]: https://esmvaltool.readthedocs.io/en/latest/
44+
[tutorial-repo]: https://esmvalgroup.github.io/ESMValTool_Tutorial/
45+
[tutorial-site]: https://esmvalgroup.github.io/ESMValTool_Tutorial
46+
[user-engagement]: https://github.com/orgs/ESMValGroup/teams/userengagementteam
47+
[contact-info]: https://docs.esmvaltool.org/en/latest/community/contact.html

0 commit comments

Comments
 (0)