1
0
Fork 0

Added more istructions

master
Meliurwen 3 years ago
parent 258f47f6a3
commit 446927b169
  1. 3
      .gitignore
  2. 37
      README.md

3
.gitignore vendored

@ -11,9 +11,10 @@ dist/
__pycache__/
# Tests
.coverage
.coverage*
coverage/
.pytest_cache/
test.json
# Other
.vscode

@ -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**: