Skip to content

Commit

Permalink
docs: simplify install section
Browse files Browse the repository at this point in the history
  • Loading branch information
elmomoilanen committed May 31, 2024
1 parent 7e32ab7 commit 0897850
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ At the moment, SciPy's API *stats.bootstrap* somewhat resembles this library but

Poetry is the recommended tool for installation.

After cloning and navigating to the target folder, running the following command creates a virtual environment within this project directory and installs the default dependencies inside it
Run the following command to install default dependencies within an in-project virtual environment

```bash
poetry install
```

In-project virtual environment setup is controlled by *poetry.toml*. Default dependencies are not enough to run the unit tests as pytest is required for that and it is only included in the optional `dev` dependency group which can be installed by adding `--with dev` to the above installation command.
In-project virtual environment setup is controlled by *poetry.toml*. Default dependencies are not enough to run the unit tests as pytest is required for that and it is only included in the optional `dev` dependency group which can be installed by adding `--with dev` to the command above.

For the plotting to work correctly it might be required to set the backend for Matplotlib. One way to do this is to set the MPLBACKEND environment variable (overrides any matplotlibrc configuration) for the current shell.

Expand Down

0 comments on commit 0897850

Please sign in to comment.