Skip to content

Commit 9414253

Browse files
authored
Merge pull request #447 from NLeSC/445-fix-broken-readme-links
fix broken readme links: add missing .jinja extension
2 parents 3eafb08 + 39bcbc4 commit 9414253

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ Spend less time setting up and configuring your new Python packages and comply w
55
Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
66

77
- Boilerplate unit tests and documentation,
8-
- [Python static setup configuration](template/pyproject.toml),
8+
- [Python static setup configuration](template/pyproject.toml.jinja),
99
- Open source software license,
1010
- Continuous integration with [GitHub action workflows](template/.github/workflows) for building, testing, link checking and linting,
1111
- Code style checking with [ruff](https://beta.ruff.rs/),
1212
- [Editorconfig](template/.editorconfig),
1313
- Usage and contribution documents:
14-
- [README.md](template/README.md) for package users,
15-
- [README.dev.md](template/README.dev.md) for package developer,
16-
- [project_setup.md](template/project_setup.md) with extensive documentation about project setup,
14+
- [README.md](template/README.md.jinja) for package users,
15+
- [README.dev.md](template/README.dev.md.jinja) for package developer,
16+
- [project_setup.md](template/project_setup.md.jinja) with extensive documentation about project setup,
1717
- [Change log](template/CHANGELOG.md),
18-
- [Code of Conduct](template/CODE_OF_CONDUCT.md),
19-
- [Contributing guidelines](template/CONTRIBUTING.md),
18+
- [Code of Conduct](template/CODE_OF_CONDUCT.md.jinja),
19+
- [Contributing guidelines](template/CONTRIBUTING.md.jinja),
2020
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),
2121
- Automatic creation of [issues](template/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs,
22-
- Instructions how to make package [citable](template/.github/next_steps/02_citation.md)
22+
- Instructions how to make package [citable](template/.github/next_steps/02_citation.md.jinja)
2323
- FAIR software recommendation badge,
24-
- Optional [pre commit hook](template/README.dev.md#running-linters-locally) to catch lint errors early
24+
- Optional [pre commit hook](template/README.dev.md.jinja#running-linters-locally) to catch lint errors early
2525

2626
## Badges
2727

@@ -92,7 +92,7 @@ copier copy https://github.com/nlesc/python-template.git path/to/destination
9292
| code_of_conduct_email | [email protected] | Email address of the person who should be contacted in case of violations of the Code of Conduct. |
9393

9494
Once the project files have been generated, follow the steps outlined in
95-
[next_steps.md](template/next_steps.md).
95+
[next_steps.md](template/next_steps.md.jinja).
9696

9797
#### Step 2/2: Read about what was just generated
9898

@@ -152,7 +152,7 @@ Good job! You have now generated the skeleton for your package:
152152
└── .zenodo.json
153153
```
154154

155-
For an explanation of what's there, read on in the [project_setup.md](template/project_setup.md) file.
155+
For an explanation of what's there, read on in the [project_setup.md](template/project_setup.md.jinja) file.
156156

157157
### Scenario 2: Apply to pre-existing code
158158

0 commit comments

Comments
 (0)