Skip to content

Commit bfac645

Browse files
committed
docs: add getting started section with screenshots
Add step-by-step instructions for using the template with screenshots showing the "Use this template" button and repository creation page.
1 parent 70506a7 commit bfac645

4 files changed

Lines changed: 17 additions & 0 deletions

File tree

.github/images/create_new_repo.png

101 KB
Loading
243 KB
Loading

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
A template for creating Python packages with UV dependency management, pytest testing, semantic-release versioning, and optional Astro Starlight documentation.
44

5+
## Getting started
6+
7+
1. Click the **Use this template** button on GitHub:
8+
9+
!["Use this template" button](.github/images/use_this_template.png)
10+
11+
2. Select **Create a new repository**, fill in the repository name, and click **Create repository**:
12+
13+
!["Create a new repository" page](.github/images/create_new_repo.png)
14+
15+
3. Clone your new repository and continue with the setup below.
16+
517
## Prerequisites
618

719
- Python 3.10+

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,11 @@ def main() -> int:
288288
for filepath in setup_files:
289289
if filepath.exists():
290290
filepath.unlink()
291+
292+
images_dir = SCRIPT_DIR / ".github" / "images"
293+
if images_dir.exists():
294+
shutil.rmtree(images_dir)
295+
291296
print_success("Setup files removed")
292297

293298
print_header("Setup complete")

0 commit comments

Comments
 (0)