Skip to content

Commit c0b2da3

Browse files
authored
Final QA (#545)
1 parent 10c2189 commit c0b2da3

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

readme-python-project/README-template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
**Table of Contents**
1414

1515
- [Installation](#installation)
16-
- [Execution / Usage](#execution-usage)
16+
- [Execution / Usage](#execution--usage)
1717
- [Technologies](#technologies)
1818
- [Features](#features)
1919
- [Contributing](#contributing)
@@ -27,13 +27,13 @@
2727
On macOS and Linux:
2828

2929
```sh
30-
$ pip install <project-name>
30+
$ python -m pip install <project-name>
3131
```
3232

3333
On Windows:
3434

3535
```sh
36-
PS> pip install <project-name>
36+
PS> python -m pip install <project-name>
3737
```
3838

3939
## Execution / Usage
@@ -52,7 +52,7 @@ from project import Project
5252
...
5353
```
5454

55-
For more examples, please refer to the project's [Wiki](wiki) or [documentation page](page).
55+
For more examples, please refer to the project's [Wiki](wiki) or [documentation page](docs).
5656

5757
## Technologies
5858

@@ -73,7 +73,7 @@ For more examples, please refer to the project's [Wiki](wiki) or [documentation
7373

7474
To contribute to the development of < project's name >, follow the steps below:
7575

76-
1. Fork < project's name > from (<https://github.com/yourusername/yourproject/fork>)
76+
1. Fork < project's name > from <https://github.com/yourusername/yourproject/fork>
7777
2. Create your feature branch (`git checkout -b feature-new`)
7878
3. Make your changes
7979
4. Commit your changes (`git commit -am 'Add some new feature'`)
@@ -95,10 +95,10 @@ The < project's name > development team really appreciates and thanks the time a
9595

9696
## Change log
9797

98-
- 0.0.1
99-
* First working version
10098
- 0.0.2
10199
- Polish the user interface
100+
- 0.0.1
101+
* First working version
102102
- ...
103103

104104
## License

0 commit comments

Comments
 (0)