Skip to content

Commit 319e155

Browse files
committed
docs: update badges block and fix links to docs + demo actions
1 parent a2bd301 commit 319e155

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,25 @@
77
</h1>
88

99
<!-- badges-begin -->
10-
11-
[![Maturin User Guide](https://img.shields.io/badge/user-guide-brightgreen?logo=readthedocs&style=flat-square)](https://robust-python.dev/cookiecutter)
12-
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square)](https://github.com/astral-sh/uv)
13-
[![Python Versions](https://img.shields.io/pypi/pyversions/robust-python-demo?style=flat-square)](https://github.com/robust-python/cookiecutter-robust-python)
14-
[![Python demo status](https://github.com/robust-python/cookiecutter-robust-python/actions/workflows/python-demo.yml/badge.svg?style=flat-square)](https://github.com/robust-python/robust-python-demo/actions)
15-
[![Maturin demo status](https://github.com/robust-python/cookiecutter-robust-python/actions/workflows/maturin-demo.yml/badge.svg)](https://github.com/robust-python/robust-maturin-demo/actions)
16-
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white&style=flat-square)](https://discord.gg/XZAHSBgqXU)
17-
10+
[![User Guide][user-guide-badge]][user-guide-page]
11+
[![uv][uv-badge]][uv-page]
12+
[![Python Versions][python-versions-badge]][python-versions-page]
13+
[![Python demo status][robust-python-demo-status-badge]][robust-python-demo-status-page]
14+
[![Maturin demo status][robust-maturin-demo-status-badge]][robust-maturin-demo-status-page]
15+
[![Discord][discord-badge]][discord-page]
16+
17+
[user-guide-badge]: https://img.shields.io/badge/user-guide-brightgreen?logo=readthedocs&style=flat-square
18+
[user-guide-page]: https://cookiecutter-robust-python.readthedocs.io/
19+
[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square
20+
[uv-page]: https://github.com/astral-sh/uv
21+
[python-versions-badge]: https://img.shields.io/pypi/pyversions/robust-python-demo?style=flat-square
22+
[python-versions-page]: https://github.com/robust-python/cookiecutter-robust-python
23+
[robust-python-demo-status-badge]: https://img.shields.io/github/actions/workflow/status/robust-python/robust-python-demo/release-python.yml?branch=main&style=flat-square&label=robust-python-demo
24+
[robust-python-demo-status-page]: https://github.com/robust-python/robust-python-demo
25+
[robust-maturin-demo-status-badge]: https://img.shields.io/github/actions/workflow/status/robust-python/robust-maturin-demo/release-python.yml?branch=main&style=flat-square&label=robust-maturin-demo
26+
[robust-maturin-demo-status-page]: https://github.com/robust-python/robust-maturin-demo
27+
[discord-badge]: https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white&style=flat-square
28+
[discord-page]: https://discord.gg/XZAHSBgqXU
1829
<!-- badges-end -->
1930

2031
# cookiecutter-robust-python
@@ -52,13 +63,10 @@ After generating your project, set it up for development:
5263
```bash
5364
cd my-awesome-project
5465

55-
# Set up virtual environment and install dependencies
56-
uvx nox -s setup-venv
57-
58-
# Initialize git repository with main/develop branches
59-
uvx nox -s setup-git
66+
# Sets up venv + git (same as nox -s setup-venv && nox -s setup-git)
67+
uvx nox -t env
6068

61-
# Set up remote repository (requires empty remote repo to exist)
69+
# Sets up remote repository (requires empty remote repo to exist)
6270
uvx nox -s setup-remote
6371
```
6472

0 commit comments

Comments
 (0)