Skip to content

Commit f764d29

Browse files
committed
fix: use template link in README
1 parent 1e9e83c commit f764d29

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,15 @@ A Python project template to save you time and energy.
1212

1313
</div>
1414

15-
Python projects take a long time to setup with all the various files, the virtual environment, and keeping things uniform across projects. With this Python template, you can quickly setup boilerplate code and miscellaneous items for your Python project saving you time and energy so you can get back to coding.
15+
Python projects take a long time to setup with all the various files, the virtual environment, and keeping things uniform across projects. With this Python template, you can quickly setup boilerplate code and miscellaneous items for your Python project saving you time and energy so you can get back to coding.
1616

1717
## Install
1818

19-
Click the `Use this template` button at the top of this project's GitHub page, it looks like this:
20-
21-
<img src="https://raw.githubusercontent.com/justintime50/assets/main/src/templates/use_template_button.png" alt="Use Template Button">
19+
Click the [Use this template](https://github.com/Justintime50/python-template/generate) button at the top of this project's GitHub page to get started.
2220

2321
## Usage
2422

25-
**Easy text replacements**
23+
### Easy text replacements
2624

2725
1. Replace all instances of `project_name` with the name of your project
2826
* These are the Python snake_case references (eg: `project_name`)
@@ -31,7 +29,7 @@ Click the `Use this template` button at the top of this project's GitHub page, i
3129
1. Replace all instances of `USERNAME` with the name of the author or owner of the project
3230
* These are references typically found in the URL of your project as it appears on GitHub
3331

34-
**File configuration**
32+
### File configuration
3533

3634
1. Configure the `setup.py` file
3735
1. Configure the `Makefile` targets
@@ -41,7 +39,7 @@ Click the `Use this template` button at the top of this project's GitHub page, i
4139
1. Rename other files/folders as needed and configure their content
4240
1. Delete this `README` and rename `README_project.md` to `README.md`
4341

44-
**GitHub configuration**
42+
### GitHub configuration
4543

4644
1. Add a `PYPI_API_TOKEN` GitHub secret to your project so that automated releasing can occur from GitHub Actions to PyPI and uncomment the final step on the `release` job in `.github/workflows/release.yml`
4745

0 commit comments

Comments
 (0)