Skip to content

Commit 5526df3

Browse files
committed
update Readme with development hints
1 parent 3d9966e commit 5526df3

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ in 1D taken from [GSTools](https://geostat-framework.readthedocs.io/projects/gst
1313

1414
## Structure
1515

16-
Please organize your example in the given Structure
16+
Please try to organize your example in the given Structure
1717
- `data/` - here you should place your input data
1818
- `src/` - here you should place your python scripts
1919
- `results/` - here your computed results and plots should be stored
2020
- `README.md` - please describe your example in the readme, potentially showing results
21+
- `LICENSE` - the default license is MIT, you can use another one if wanted
2122

2223

2324
## Python environment
@@ -34,6 +35,9 @@ After finalizing your work, you should tag the repository with a version like `v
3435

3536
Then, a [Zenodo](https://zenodo.org/) release will be created, so you can cite the repository in you publication.
3637

38+
Please keep your `master` branch in line with the latest release.
39+
For further development use the `develop` branch and update `master` with pull-requests.
40+
3741

3842
## Contact
3943

0 commit comments

Comments
 (0)