Skip to content

Commit

Permalink
Add installation instructions (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
qexat authored May 2, 2023
1 parent b54fb58 commit 6b9928e
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@ Requires Python 3.9 or higher.

This library attempts to cover as many escape sequences as possible ; but it is not an exhaustive list, some might be missing. Also, you might find that few have no effect on your terminal emulator.

## Install

### Normal installation

```sh
pip install coquille
```

### Dev installation

```sh
pip install coquille[dev]
```

This allows you to run the tests:

```sh
coverage run -m pytest
```

Then check the coverage:

```sh
coverage report -m
```

## Examples

### Coquille context manager
Expand Down

0 comments on commit 6b9928e

Please sign in to comment.