From 6b9928ebe2f78060345fe9ac33e9415bc0764c50 Mon Sep 17 00:00:00 2001 From: qexat <43090614+qexat@users.noreply.github.com> Date: Tue, 2 May 2023 23:09:28 +0200 Subject: [PATCH] Add installation instructions (#7) --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 63a2d83..8708eb5 100644 --- a/README.md +++ b/README.md @@ -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