diff --git a/README.md b/README.md index 6eb68d20..de473bfc 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ that are automatically generated and kept in sync with this template. - documentation hosted by [readthedocs][] - coverage tests with [codecov][] - [pre-commit][] checks for code style and consistency -- tutorials with [nbsphinx][] and jupyter notebooks +- tutorials with [myst-nb][] and jupyter notebooks - issue templates for better bug reports and feature requests - [bump2version][] for managing releases @@ -66,7 +66,7 @@ All CI checks should pass, you are ready to start developing your new tool! ### Customizations -Further instructions on using this template can be found in the contributing guide included in the project. +Further instructions on using this template can be found in the [dev docs included in the project](https://cookiecutter-scverse-instance.readthedocs.io/en/latest/developer_docs.html). ### Committment @@ -96,7 +96,7 @@ Note that when creating a new release, changes will be propagated to packages us [write-tests]: https://cookiecutter-scverse-instance.readthedocs.io/en/latest/developer_docs.html#writing-tests [write-docs]: https://cookiecutter-scverse-instance.readthedocs.io/en/latest/developer_docs.html#writing-documentation [readthedocs]: https://readthedocs.org/ -[nbsphinx]: https://github.com/spatialaudio/nbsphinx +[myst-nb]: https://myst-nb.readthedocs.io/ [pre-commit]: https://pre-commit.com/ [bump2version]: https://github.com/c4urself/bump2version/ [scverse]: https://scverse.org/ diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 47bf55a6..d21bf292 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -18,7 +18,7 @@ Please refer to the [documentation][link-docs]. In particular, the ## Installation You need to have Python 3.8 or newer installed on your system. If you don't have -Python installed, we recommend installing [Miniconda](https://docs.conda.io/en/latest/miniconda.html). +Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge). There are several alternative options to install {{ cookiecutter.project_name }}: