Skip to content

Commit 2d60fa7

Browse files
committed
enh: more cleanup for minimal mode
1 parent f3a95ad commit 2d60fa7

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

template/README.md.jinja

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
11
# {{ project_name }}
22

33
| | |
4-
|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) [![Documentation](https://readthedocs.org/projects/{{project_slug}}/badge/?version=latest)](https://{{project_slug}}.readthedocs.io/en/latest/?badge=latest) |
6-
| Meta | [![{{ license }}](https://img.shields.io/pypi/l/{{project_slug}}.svg)](LICENSE) [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](.github/CODE_OF_CONDUCT.md) [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/) [![Code Style Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) |
7-
| Automation | |
4+
|---|----------------|
5+
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/{{project_slug}}.svg)](https://pypi.org/project/{{project_slug}}/) {% if use_rtd %}[![Documentation](https://readthedocs.org/projects/{{project_slug}}/badge/?version=latest)](https://{{project_slug}}.readthedocs.io/en/latest/?badge=latest) {% endif %} |
6+
| Meta | [![{{ license }}](https://img.shields.io/pypi/l/{{project_slug}}.svg)](LICENSE) [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](.github/CODE_OF_CONDUCT.md) |
7+
| Automation | |
88

99
_{{ package_description }}_
1010

11+
TODO: Add more about what the package does here.
12+
13+
## Get started
14+
15+
You can install this package into your preferred Python environment using pip:
16+
17+
```bash
18+
$ pip install {{ project_slug }}
19+
```
20+
21+
TODO: Add a brief example of how to use the package to this section
22+
23+
To use {{ project_slug }} in your code:
24+
25+
```python
26+
>>> import {{ project_slug }}
27+
>>> {{ project_slug }}.hello_world()
28+
```
29+
1130
## Copyright
1231

1332
{% include pathjoin("includes", "licenses", "stub.md.jinja") %}

template/{% if use_git and dev_platform == 'GitHub' %}.github{% endif %}/ISSUE_TEMPLATE/02-question.yml.jinja renamed to template/{% if use_git and dev_platform == 'GitHub' %}.github{% endif %}/ISSUE_TEMPLATE/{% if template_mode != 'minimal' %}02-question.yml{% endif %}.jinja

File renamed without changes.

template/{% if use_git and dev_platform == 'GitHub' %}.github{% endif %}/ISSUE_TEMPLATE/03-feature-request.yml.jinja renamed to template/{% if use_git and dev_platform == 'GitHub' %}.github{% endif %}/ISSUE_TEMPLATE/{% if template_mode != 'minimal' %}03-feature-request.yml{% endif %}.jinja

File renamed without changes.

0 commit comments

Comments
 (0)