Skip to content

Commit de47337

Browse files
committed
πŸ“š Update feature list
1 parent 8602c68 commit de47337

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ Template for Python packages based on [`copier`](https://copier.readthedocs.io/e
66

77
## Features
88

9-
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
10-
* πŸ“š **Documentation**: Document your package in [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
11-
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
9+
* πŸ“¦ **Package management**:
10+
- Develop with your preferred tools (extras, [`uv`](https://docs.astral.sh/uv/) or [Hatch](https://hatch.pypa.io/)).
11+
- Build your package with [Hatch](https://hatch.pypa.io/).
12+
* 🧹 [**Pre-commit**](https://pre-commit.com/): Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
13+
* πŸ§ͺ **Tests**: Write tests with [`pytest`](https://docs.pytest.org/en/stable/).
14+
* πŸ“š **Documentation**: Write docs in [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
1215
* βš™οΈ **GitHub Actions**:
1316
* Deploy documentation to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) or [Read the Docs](https://about.readthedocs.com/).
1417
* Run pre-commit checks and tests on every pull request.

β€Ždocs/index.mdβ€Ž

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ A `copier`-based template for Python packages.
44

55
## Features
66

7-
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
8-
* πŸ“š **Documentation**: Document your package in [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
9-
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
7+
* πŸ“¦ **Package management**:
8+
- Develop with your preferred tools (extras, [`uv`](https://docs.astral.sh/uv/) or [Hatch](https://hatch.pypa.io/)).
9+
- Build your package with [Hatch](https://hatch.pypa.io/).
10+
* 🧹 [**Pre-commit**](https://pre-commit.com/): Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
11+
* πŸ§ͺ **Tests**: Write tests with [`pytest`](https://docs.pytest.org/en/stable/).
12+
* πŸ“š **Documentation**: Write docs in [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/).
1013
* βš™οΈ **GitHub Actions**:
1114
* Deploy documentation to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) or [Read the Docs](https://about.readthedocs.com/).
1215
* Run pre-commit checks and tests on every pull request.

0 commit comments

Comments
Β (0)