Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

venv noob friendly changes #23

Merged
merged 1 commit into from
May 24, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/user/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ proper installation of a software package is the first step to use it.

Using PIP
---------
.. warning::
We highly recommend that you *do not* install Pynguin in your system's or user's
Python package store; instead we recommend to use a `virtual environment <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#installing-virtualenv>`_.

This prevents issues between your system's package store and Pynguin's dependencies -
which can easily cause version conflicts with other Python packages.

The easiest way to obtain Pynguin is by running this command in your terminal of
choice::

$ pip install pynguin

We highly recommend that you *do not* install Pynguin in your system's or user's
Python package store; instead we recommend to use a virtual environment.
This prevents that you spoil your system package store with Pynguin's dependencies,
which can easily cause version conflicts with other Python packages.

Get the Source Code
-------------------

Expand Down