Skip to content

Commit

Permalink
Cite example repos that actually use this template
Browse files Browse the repository at this point in the history
  • Loading branch information
liamhuber committed Jan 17, 2024
1 parent 0bc2902 commit 690fccd
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@

This repository is a template for new pyiron modules similar to the existing modules of the
pyiron framework, e.g.
[pyiron_base](https://github.com/pyiron/pyiron_base),
[pyiron_atomistics](https://github.com/pyiron/pyiron_atomistics),
and
[pyiron_contrib](https://github.com/pyiron/pyiron_contrib).
[pyiron_workflow](https://github.com/pyiron/pyiron_workflow),
[pyiron_ontology](https://github.com/pyiron/pyiron_ontology),
etc.

Within this repository, the new module is called `pyiron_module_template` which should be renamed to `pyiron_IntendedModuleName`.
This can be easily achieved by modifying and running the update_module_name.sh script.
Expand Down

0 comments on commit 690fccd

Please sign in to comment.