diff --git a/README.md b/README.md index f2352527..3f5ead10 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,23 @@ Use this [Cookiecutter](https://cookiecutter.readthedocs.io) template to generat an empty Python package. Features include: - Boilerplate unit tests and documentation, -- [Python static setup configuration]({{cookiecutter.project_name}}/setup.cfg), +- [Python static setup configuration]({{cookiecutter.directory_name}}/setup.cfg), - Open source software license, -- Continuous integration with [GitHub action workflows]({{cookiecutter.project_name}}/.github/workflows) for building, testing, link checking and linting, +- Continuous integration with [GitHub action workflows]({{cookiecutter.directory_name}}/.github/workflows) for building, testing, link checking and linting, - Code style checking with [prospector](https://pypi.org/project/prospector/), -- [Editorconfig]({{cookiecutter.project_name}}/.editorconfig), +- [Editorconfig]({{cookiecutter.directory_name}}/.editorconfig), - Usage and contribution documents: - - [README.md]({{cookiecutter.project_name}}/README.md) for package users, - - [README.dev.md]({{cookiecutter.project_name}}/README.dev.md) for package developer, - - [project_setup.md]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup, - - [Change log]({{cookiecutter.project_name}}/CHANGELOG.md), - - [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.md), - - [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.md), + - [README.md]({{cookiecutter.directory_name}}/README.md) for package users, + - [README.dev.md]({{cookiecutter.directory_name}}/README.dev.md) for package developer, + - [project_setup.md]({{cookiecutter.directory_name}}/project_setup.md) with extensive documentation about project setup, + - [Change log]({{cookiecutter.directory_name}}/CHANGELOG.md), + - [Code of Conduct]({{cookiecutter.directory_name}}/CODE_OF_CONDUCT.md), + - [Contributing guidelines]({{cookiecutter.directory_name}}/CONTRIBUTING.md), - Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/), -- Automatic creation of [issues]({{cookiecutter.project_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs, -- Instructions how to make package [citable]({{cookiecutter.project_name}}/.github/next_steps/04_citation.md) +- Automatic creation of [issues]({{cookiecutter.directory_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs, +- Instructions how to make package [citable]({{cookiecutter.directory_name}}/.github/next_steps/04_citation.md) - FAIR software recommendation badge, -- Optional [pre commit hook](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/README.dev.md#running-linters-locally) to catch lint errors early +- Optional [pre commit hook]({{cookiecutter.directory_name}}/README.dev.md#running-linters-locally) to catch lint errors early ## Badges @@ -144,7 +144,7 @@ my-python-project/ └── test_my_module.py ``` -For an explanation of what's there, read on in the [project_setup.md]({{cookiecutter.project_name}}/project_setup.md) file. +For an explanation of what's there, read on in the [project_setup.md]({{cookiecutter.directory_name}}/project_setup.md) file. There are also instructions on how to [apply the template to an existing Python package](ADD_TO_EXISTING_PACKAGE.md). ## Examples