Skip to content

Commit 1725595

Browse files
author
a.pirogov
committed
update README with mindmap, closes #13
1 parent fbbab34 commit 1725595

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010

1111
An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata.
1212

13+
<!-- NOTE: For technical reasons, it is much easier to use GitHub
14+
for hosting the mindmap than adding it to the repository -->
15+
![FAIR Software Mindmap](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/assets/371708/1eba8eaf-663f-4475-b6ce-39fac1a183b5)
16+
1317
*Check out a demo repository generated from this template
1418
:point_right: [here](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo)*
1519

@@ -49,11 +53,12 @@ This template sets up a skeleton for a Python project that:
4953
* helps following best practices for code and metadata quality
5054
* contains detailed documentation on how to work with it
5155

52-
It is built to help you adopting good development practices
56+
It is built to help you adopting good practices
5357
and follow recommendations such as:
5458

5559
* [DLR Software Engineering Guidelines](https://rse.dlr.de/guidelines/00_dlr-se-guidelines_en.html)
5660
* [OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/en/criteria/0)
61+
* [Netherlands eScience Center](https://fair-software.eu)
5762
* innumerable other resources that can be found online
5863

5964
Furthermore, it implements emerging standards with the goal to improve

0 commit comments

Comments
 (0)