Skip to content

Commit e78e0c2

Browse files
author
Tim-ats-d
committed
Markdown corrections in README.md and CONTRIBUTING.md
1 parent 51dfa52 commit e78e0c2

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
# Contributing
2+
# Contributing
33

44
## Setup your development environment
55

66
You need:
77
* `Python3.6`: you can install it by following [Python3's documentation](https://www.python.org/downloads/).
88
* `curses`: available in standard library of `Python` but it doesn't work out-of-the-box on Windows. See [this](https://www.devdungeon.com/content/curses-windows-python) explanations to install `curses` on Windows.
99

10-
## Branches
10+
## Branches
1111

1212
* main : stable releases.
1313

@@ -31,7 +31,7 @@ python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
3131
```
3232
The list of versions and their changelogs can be found [here](https://github.com/Tim-ats-d/Visual-dialog/releases/).
3333

34-
## Repository Structure
34+
## Repository Structure
3535

3636
The following snippet describes Visual-dialog's repository structure.
3737

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<a href="#features">Features</a> •
99
<a href="#installation">Installation</a> •
1010
<a href="#documentation">Documentation</a> •
11-
<a href="#quick-start ">Usage</a> •
11+
<a href="#quick-start">Quick start</a> •
1212
<a href="#contributing">Contributing</a> •
1313
<a href="#license">License</a>
1414
</p>
@@ -28,7 +28,10 @@
2828
## Installation
2929

3030
### Using pip
31-
`pip install git+git://github.com/Tim-ats-d/Visual-dialog`
31+
32+
```bash
33+
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog
34+
```
3235
(The lib is not yet available on **pypy**).
3336

3437
### Requirements

0 commit comments

Comments
 (0)