Skip to content

Commit b2d1b34

Browse files
authored
docs: 📝 improve README from t-squared (#273)
# Description Needs no review.
1 parent 9106e1d commit b2d1b34

3 files changed

Lines changed: 36 additions & 37 deletions

File tree

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,30 @@ state and is being actively
2020
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
2121

2222
This repository contains a
23-
[copier](https://copier.readthedocs.io/en/stable/) template for setting
24-
up a new repository for a Python package. Along with a structured
25-
directory layout, this template includes configurations for tools that
26-
improve developer experience, continuous integration and delivery
27-
workflows, and supporting files for building robust Python packages.
23+
[Copier](https://copier.readthedocs.io/en/stable/) template for setting
24+
up a new repository for a Python package. We made this template because
25+
we manage and develop several Python packages in Seedcase, and this
26+
template is designed to make it easier to create, develop, and maintain
27+
those Python packages.
2828

2929
Check out our
3030
[website](https://template-python-package.seedcase-project.org) for more
3131
information, such as the features it provides and a
3232
[guide](https://template-python-package.seedcase-project.org/docs/guide)
3333
to using the template. For a list of changes, see our
34-
[changelog](https://template-python-package.seedcase-project.org/changelog.html)
35-
page.
34+
[changelog](CHANGELOG.md) page.
35+
36+
> [!TIP]
37+
>
38+
> This template repository was generated from the
39+
> [t-squared](https://github.com/seedcase-project/t-squared) Seedcase
40+
> template :tada:
3641
3742
## Contributing
3843

39-
Check out our [contributing
40-
page](https://template-python-package.seedcase-project.org/contributing)
41-
for information on how to contribute to the project, including how to
42-
set up your development environment.
44+
Check out our [contributing page](CONTRIBUTING.md) for information on
45+
how to contribute to the project, including how to set up your
46+
development environment.
4347

4448
Please note that this project is released with a [Contributor Code of
4549
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
@@ -50,21 +54,18 @@ to abide by its terms.
5054
The following people have contributed to this project by submitting pull
5155
requests :tada:
5256

57+
[@joelostblom](https://github.com/joelostblom),
5358
[@lwjohnst86](https://github.com/lwjohnst86),
5459
[@martonvago](https://github.com/martonvago),
55-
[@signekb](https://github.com/signekb),
56-
[@joelostblom](https://github.com/joelostblom)
60+
[@signekb](https://github.com/signekb)
5761

5862
## Licensing
5963

6064
This project is licensed under the [MIT License](LICENSE.md).
6165

6266
## Citing
6367

64-
This project is part of the Seedcase Project, which is a collaborative
65-
effort to create a framework for data management and analysis in
66-
research. If you use this project in your work, please cite it as
67-
follows:
68+
If you use this project in your work, please cite it as follows:
6869

6970
Johnston L.W., Brødbæk S.K., Beicher K., Vago M. (2025). Template Python
7071
Package: An opinionated setup for making Python packages DOI:

README.qmd

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,37 @@
22
format: gfm
33
execute:
44
echo: false
5-
jupyter: python3
65
metadata-files:
76
- _metadata.yml
87
---
98

10-
# {{< meta titles.full >}}
9+
# {{< meta tagline >}}
1110

1211
{{< include /docs/includes/_badges.qmd >}}
1312

1413
This repository contains a
15-
[copier](https://copier.readthedocs.io/en/stable/) template for setting
16-
up a new repository for a Python package. Along with a structured
17-
directory layout, this template includes configurations for tools that
18-
improve developer experience, continuous integration and delivery
19-
workflows, and supporting files for building robust Python packages.
14+
[Copier](https://copier.readthedocs.io/en/stable/) template for setting
15+
up a new repository for a Python package. We made this template because
16+
we manage and develop several Python packages in Seedcase, and this
17+
template is designed to make it easier to create, develop, and maintain
18+
those Python packages.
2019

2120
Check out our [website]({{< meta links.site >}}) for more information,
2221
such as the features it provides and a
2322
[guide]({{< meta links.site >}}/docs/guide) to using the template. For a
24-
list of changes, see our
25-
[changelog]({{< meta links.site >}}/changelog.html) page.
23+
list of changes, see our [changelog](CHANGELOG.md) page.
24+
25+
::: callout-tip
26+
This template repository was generated from the
27+
[t-squared](https://github.com/seedcase-project/t-squared) Seedcase
28+
template :tada:
29+
:::
2630

2731
## Contributing
2832

29-
Check out our [contributing page]({{< meta links.site >}}/contributing)
30-
for information on how to contribute to the project, including how to
31-
set up your development environment.
33+
Check out our [contributing page](CONTRIBUTING.md) for information on
34+
how to contribute to the project, including how to set up your
35+
development environment.
3236

3337
Please note that this project is released with a
3438
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in
@@ -44,10 +48,7 @@ This project is licensed under the [MIT License](LICENSE.md).
4448

4549
## Citing
4650

47-
This project is part of the Seedcase Project, which is a collaborative
48-
effort to create a framework for data management and analysis in
49-
research. If you use this project in your work, please cite it as
50-
follows:
51+
If you use this project in your work, please cite it as follows:
5152

5253
```{python}
5354
#| output: asis

_metadata.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# Metadata for the website
21
gh:
32
org: "seedcase-project"
43
repo: "template-python-package"
54

6-
titles:
7-
full: "Template Python Package: An opinionated setup for making Python packages"
8-
short: "Template Python Package"
5+
tagline: "Template Python Package: An opinionated setup for making Python packages"
96

107
links:
118
github: "https://github.com/seedcase-project/template-python-package"

0 commit comments

Comments
 (0)