Skip to content

Commit aa08733

Browse files
committed
docs: add pin images and generally pull a lot of inspiration from the areg-sdk repo
1 parent c538b9b commit aa08733

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,15 @@
2828
⭐ Star us on <a href="https://github.com/robust-python/cookiecutter-robust-python/">GitHub</a> — it motivates us a lot and helps to pay the rent!
2929
</h4>
3030

31-
# cookiecutter-robust-python
31+
---
3232

3333
**[cookiecutter-robust-python]** is a template made with the understanding that **project needs change over time**.
3434

3535
The **[Robust Python Cookiecutter]** aims to provide **best practice tooling/CICD** within a structure designed for **future adaptability**.
3636

3737
---
3838

39-
<details open="open">
40-
<summary>Table of Contents</summary>
39+
## Table of Contents[![](./docs/_static/pin.svg)](#table-of-contents)
4140

4241
- [About](#about)
4342
- [Key Features](#key-features)
@@ -50,9 +49,7 @@ The **[Robust Python Cookiecutter]** aims to provide **best practice tooling/CIC
5049
- [Why does this project exist?](#why-does-this-project-exist)
5150
- [Contributing](#contributing)
5251

53-
</details>
54-
55-
## About
52+
## About[![](./docs/_static/pin.svg)](#table-of-contents)
5653

5754
### Key Features
5855
- Uses [cruft] to allow for easily transitioning between:
@@ -74,7 +71,12 @@ The **[Robust Python Cookiecutter]** aims to provide **best practice tooling/CIC
7471
- [pip-audit] for security vulnerability checking
7572
- [maturin] (optional) for rust integration when needed
7673

77-
## Getting Started
74+
75+
<div align="right"><kbd><a href="#table-of-contents">↑ Back to top ↑</a></kbd></div>
76+
77+
---
78+
79+
## Getting Started[![](./docs/_static/pin.svg)](#table-of-contents)
7880

7981
### Prerequisites
8082
The only requirement is installing [uv].
@@ -116,12 +118,15 @@ gh repo create my-awesome-project
116118
uvx nox -s setup-remote
117119
```
118120

119-
###### *Just a general note, sessions named "setup-..." are not idempotent*
121+
> ⚠️ Scripts and nox sessions prefixed with "setup-" are usually not idempotent, although some will try to warn you if misused.
120122
121123
From there all that is left is setting up various integrations like Pypi publishing and Readthedocs as desired.
122124

125+
<div align="right"><kbd><a href="#table-of-contents">↑ Back to top ↑</a></kbd></div>
123126

124-
## Roadmap
127+
---
128+
129+
## Roadmap[![](./docs/_static/pin.svg)](#table-of-contents)
125130

126131
This is a really brief/condensed idea of what is planned for this template, and where it stands currently:
127132
<details>
@@ -155,8 +160,11 @@ This is a really brief/condensed idea of what is planned for this template, and
155160
| [gitlab] | [![Python demo status][robust-gitlab-python-demo-status-badge]][robust-gitlab-python-demo-status-page][![Maturin demo status][robust-gitlab-maturin-demo-status-badge]][robust-gitlab-maturin-demo-status-page] |
156161
| [bitbucket] | [![Python demo status][robust-bitbucket-python-demo-status-badge]][robust-bitbucket-python-demo-status-page][![Maturin demo status][robust-bitbucket-maturin-demo-status-badge]][robust-bitbucket-maturin-demo-status-page] |
157162

163+
<div align="right"><kbd><a href="#table-of-contents">↑ Back to top ↑</a></kbd></div>
164+
165+
---
158166

159-
## Why does this project exist?
167+
## Why does this project exist?[![](./docs/_static/pin.svg)](#table-of-contents)
160168

161169
Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.
162170
While it will always have a place in my heart, there have been far too many improvements in Python tooling to keep using it as is.
@@ -169,8 +177,11 @@ a handful of issues with it that prevented it from being able to adapt to new Py
169177

170178
The goal is for [cookiecutter-robust-python] to fill the gap that exists for a best practices template that is structured to be adaptable from the start.
171179

180+
<div align="right"><kbd><a href="#table-of-contents">↑ Back to top ↑</a></kbd></div>
181+
182+
---
172183

173-
## Contributing
184+
## Contributing[![](./docs/_static/pin.svg)](#table-of-contents)
174185

175186
For more information on contributing to the [Robust Python Cookiecutter], please visit the [contributing] docs.
176187

0 commit comments

Comments
 (0)