Skip to content

Update README with init script instructions #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
idatsy merged 1 commit into from
May 25, 2025
Merged

Update README with init script instructions #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,15 @@ you can focus on writing code rather than configuring your environment.

## Getting Started

1. **Replace** all occurrences of `template` with your project name. This is
primarily in `pyproject.toml` and the `template/` package directory.
1. **Initialize the project** by running the helper script which replaces
placeholder names with your project name:

```bash
./scripts/init_repo.sh
Copy link

Copilot AI May 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a note that the script must be executable (e.g., chmod +x scripts/init_repo.sh) or can be invoked explicitly with bash scripts/init_repo.sh to avoid permission errors.

Suggested change
./scripts/init_repo.sh
# Ensure the script is executable or run it explicitly with bash:
chmod +x ./scripts/init_repo.sh # Optional, to make it executable
./scripts/init_repo.sh # Or use: bash ./scripts/init_repo.sh

Copilot uses AI. Check for mistakes.
```

The script infers the project name from the repository directory and updates
files such as `pyproject.toml`, the package directory and tests accordingly.
2. **Install dependencies**:

```bash
Expand Down
Loading