Skip to content

Commit 01232d2

Browse files
committed
docs: add more details to README
1 parent 6a235e8 commit 01232d2

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,11 @@
22

33
[![test](https://github.com/dzhang32/python_package_template/actions/workflows/test.yml/badge.svg)](https://github.com/dzhang32/python_package_template/actions/workflows/test.yml)
44

5-
A [cookiecutter](https://github.com/cookiecutter/cookiecutter) python package template developed for personal use.
5+
A [cookiecutter](https://github.com/cookiecutter/cookiecutter) python package template developed for personal use.
6+
7+
## Usage
8+
9+
```bash
10+
# cookiecutter can be installed via pip/brew.
11+
cookiecutter git@github.com:dzhang32/python_package_template.git
12+
```

{{cookiecutter.package_name}}/README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,31 @@ source .venv/bin/activate
1212
uv pip install {{cookiecutter.package_name}}
1313
# Install Chromium browser binary required for playwright.
1414
playwright install chromium
15-
```
15+
```
16+
17+
## Additional setup
18+
19+
### Code coverage
20+
21+
- Add a "CODECOV_TOKEN" secret (obtained from [here](https://app.codecov.io/gh/dzhang32/test_python_package/)) to your repo via `Settings` -> `Secrets and variables` -> `Actions`.
22+
23+
{% if cookiecutter.include_docs == 'y' %}
24+
### Deploying docs to gh-pages
25+
26+
1. Go to your repository's `Settings` -> `Actions` -> `General`.
27+
2. Scroll to `Workflow permissions` and allow GHA to have `Read and write permissions` so it can create/push to the `gh-pages` branch.
28+
3. Go to `Settings` -> `Pages`.
29+
4. Configure your repo to deploy from the root of `gh-pages` branch.
30+
{% endif %}
31+
32+
{% if cookiecutter.include_pypi == 'y' %}
33+
### Deploying to PyPI
34+
35+
- Go to your [PyPi publishing settings](https://pypi.org/manage/account/publishing/) and fill in the following details:
36+
37+
- **PyPI Project Name:** {{cookiecutter.package_name}}
38+
- **Owner:** {{cookiecutter.github_username}}
39+
- **Repository name:** {{cookiecutter.package_name}}
40+
- **Workflow name:** test_deploy.yml
41+
- **Environment name:** (leave blank)
42+
{% endif %}

0 commit comments

Comments
 (0)