Skip to content

Commit 88ab903

Browse files
authored
docs: update README with new setup instructions
Reorganize README to improve clarity and add instructions.
1 parent cd6d9b3 commit 88ab903

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,6 @@ A comprehensive template repository for Python projects, designed to provide a s
1111
- **CI/CD Ready**: GitHub Actions configuration templates
1212
- **Development Tools**: Pre-commit hooks and development utilities
1313

14-
## After Cloning or Using as Template
15-
16-
Before starting development, make sure to apply the following changes:
17-
18-
1. **Rename the source folder**: `src/template-python-project/``src/<your-project-name>/`
19-
20-
2. **Update `pyproject.toml`**:
21-
- Change `name`, `version`, `description`, `authors`, and other metadata fields
22-
- Update the package source path to match your renamed `src/` folder
23-
24-
3. **Update pre-commit hook versions** in `.pre-commit-config.yaml` to the latest available:
25-
- Check [pre-commit-hooks releases](https://github.com/pre-commit/pre-commit-hooks/releases)
26-
- Check [ruff-pre-commit releases](https://github.com/astral-sh/ruff-pre-commit/releases)
27-
- Check [mirrors-mypy releases](https://github.com/pre-commit/mirrors-mypy/releases)
28-
- You can also check if the commented lines are useful for you.
29-
30-
4. **Install pre-commit hooks**:
31-
```bash
32-
uv run pre-commit install
33-
```
34-
35-
5. **Configure GitHub Actions permissions**:
36-
Go to your repository **Settings → Actions → General → Workflow permissions** and enable **"Allow GitHub Actions to create and approve pull requests"** if you want workflows to open PRs automatically.
3714

3815
## Quick Start
3916

@@ -44,11 +21,9 @@ Go to your repository **Settings → Actions → General → Workflow permission
4421

4522
### Installation
4623

47-
1. Clone the repository:
48-
```bash
49-
git clone https://github.com/v-mdev/template-python-projects.git
50-
cd template-python-projects
51-
```
24+
1. Use the template:
25+
26+
Click the button `Use this template` -> `Create a new repository`
5227

5328
2. Install dependencies:
5429
```bash
@@ -100,6 +75,30 @@ uv run mypy src/
10075
uv run pre-commit run --all-files
10176
```
10277

78+
79+
## After Cloning or Using as Template
80+
81+
Before starting development, make sure to apply the following changes:
82+
83+
1. **Rename the source folder**: `src/template-python-project/``src/<your-project-name>/`
84+
85+
2. **Update `pyproject.toml`**:
86+
- Change `name`, `version`, `description` and other metadata fields
87+
88+
3. **Update pre-commit hook versions** in `.pre-commit-config.yaml` to the latest available:
89+
- Check [pre-commit-hooks releases](https://github.com/pre-commit/pre-commit-hooks/releases)
90+
- Check [ruff-pre-commit releases](https://github.com/astral-sh/ruff-pre-commit/releases)
91+
- Check [mirrors-mypy releases](https://github.com/pre-commit/mirrors-mypy/releases)
92+
- You can also check if the commented lines are useful for you.
93+
94+
4. **Install pre-commit hooks**:
95+
```bash
96+
uv run pre-commit install
97+
```
98+
99+
5. **Configure GitHub Actions permissions**:
100+
Go to your repository **Settings → Actions → General → Workflow permissions** and enable **"Allow GitHub Actions to create and approve pull requests"** if you want workflows to open PRs automatically.
101+
103102
## Contributing
104103

105104
Contributions are welcome! Please feel free to submit a Pull Request.

0 commit comments

Comments
 (0)