Skip to content

Commit bcf0d52

Browse files
committed
Update README.md for new tutorials structure
1 parent f05d14f commit bcf0d52

1 file changed

Lines changed: 4 additions & 16 deletions

File tree

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,8 @@
1-
# preCICE Tutorials
1+
# preCICE tutorials
22

33
This repository contains ready-to-run tutorial cases for the coupling library [preCICE](http://www.precice.org/).
4-
The purpose of these cases are not to teach you how to use preCICE, but to serve as starting points for setting up similar simulation cases.
4+
The purpose of these cases is not to teach you how to use preCICE from scratch, but to serve as starting points for setting up similar simulation cases, as well as test cases. Read more on our [preCICE tutorials](https://www.precice.org/tutorials.html) documentation section.
55

6-
Each folder in this directory represents a stand-alone tutorial case containing:
7-
* a `README.md` with general instructions on how to run the simulation. This is the same content you see on the [preCICE tutorials](https://www.precice.org/tutorials.html) documentation section.
8-
* multiple participant folders with the format `<participant>-<solver>`. Pick a solver for each participant and start them to run the simulation.
9-
* a `clean.sh` script to clean each individual participant case, a `clean-tutorial.sh` to clean all participants of a tutorial case, a `clean-all.sh` to clean all tutorial cases.
6+
As a general rule, you can start each participant from inside their `<tutorial>/<participant>-<solver>` using `./run.sh`. Look into these short scripts and copy the parts you need for your new case. Before running again, execute the cleaning scripts you can find at each level, to clean from this point and deeper.
107

11-
As a general rule, you can start each participant from inside their `<participant>-<solver>` using `./run.sh`. Look into these short scripts and copy the parts you need for your new case.
12-
13-
## For contributors
14-
15-
The [preCICE tutorials](https://www.precice.org/tutorials.html) documentation section displays material from this repository. This website import relies on the following rules:
16-
* tutorials use dashes to separate words `flow-over-heated-plate`.
17-
* a tutorial contains a `REAMDE.md` with a Jekyll front-matter and a `permalink: /tutorials-flow-over-heated-plate.html`.
18-
* a tutorial may contain a folder `images/` with images to be displayed in the `README.md`.
19-
Images use the naming scheme `tutorials-flow-over-heated-plate-example.png`. Subdirectories in `images/` are not allowed.
20-
* images includes in the `README.md` use relative links to `![example](images/tutorials-flow-over-heated-plate-example.png)`.
8+
Contributions to this repository are very welcome. Please refer to the page [Contribute to preCICE](https://precice.org/community-contribute-to-precice.html) for a few guidelines and hints to help you in this direction.

0 commit comments

Comments
 (0)