You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,15 @@ A Python project template to save you time and energy.
12
12
13
13
</div>
14
14
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.
16
16
17
17
## Install
18
18
19
-
Click the `Use this template` button at the top of this project's GitHub page, it looks like this:
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.
22
20
23
21
## Usage
24
22
25
-
**Easy text replacements**
23
+
### Easy text replacements
26
24
27
25
1. Replace all instances of `project_name` with the name of your project
28
26
* 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
31
29
1. Replace all instances of `USERNAME` with the name of the author or owner of the project
32
30
* These are references typically found in the URL of your project as it appears on GitHub
33
31
34
-
**File configuration**
32
+
### File configuration
35
33
36
34
1. Configure the `setup.py` file
37
35
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
41
39
1. Rename other files/folders as needed and configure their content
42
40
1. Delete this `README` and rename `README_project.md` to `README.md`
43
41
44
-
**GitHub configuration**
42
+
### GitHub configuration
45
43
46
44
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`
0 commit comments