From 446927b169f84ecf93da91fec6d0371f4def1162 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Wed, 16 Feb 2022 13:56:35 +0100 Subject: [PATCH] Added more istructions --- .gitignore | 3 ++- README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c74793f..f386f3d 100644 --- a/.gitignore +++ b/.gitignore @@ -11,9 +11,10 @@ dist/ __pycache__/ # Tests -.coverage +.coverage* coverage/ .pytest_cache/ +test.json # Other .vscode diff --git a/README.md b/README.md index 19c654e..e68a331 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,43 @@ Download the latest release in .tar.gz or .whl format and simply use pip install pip install PyCTBN-2.2.tar.gz ``` +## Develop + +**Prerequisites:** + ++ `python3` (_>=3.6_) ++ `python3-setuptools` ++ `python3-pip` ++ `python3-venv` (_optional_) + +_Create_ the **_virtual environment_** in the project's folder: + +```sh +python3 -m venv venv +``` + +Or if oyu wanna use the `virtualenv` package: + +```sh +virtualenv -p python3 venv +``` + +_Activate_ the virtual environment: + +```sh +source venv/bin/activate +``` + +_Prepare_ the development environment: + +```sh +./setup.py develop +``` + +That's all! ☕️ + +> **Tip:** To deactivate the **_virtual environment_** simply issue the `deactivate` command. + ## Testing & Linting Install these dependencies for **tesing**: