Skip to content

Commit 42df30f

Browse files
committed
Added .env.template
1 parent 1875929 commit 42df30f

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed
File renamed without changes.

doc/dev/contribute.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,15 @@ development environment. The easiest way to do this is to use `virtualenv
9393
<http://pypi.python.org/pypi/virtualenv>`_ and `pip
9494
<http://pypi.python.org/pypi/pip>`_.
9595

96-
Some environment variables are required to be set before using the project from
97-
within Visual Studio Code (used in `launch.json` and `tasks.json`). These are:
96+
Some parameters are required to be set before using the project from within
97+
Visual Studio Code (used in `launch.json` and `tasks.json`). These are:
9898

9999
* ``PPSTACK_PYTHONEXE``: The path to the Python interpreter to use. This is
100100
used to launch the application from within Visual Studio Code. If not set,
101101
the default Python interpreter will be used.
102+
103+
* `.env` file: This file is used to set environment variables for the
104+
application. It is used to set the ``PYTHONPATH`` environment variable to
105+
the root of the project. This is required to be able to import the project
106+
modules from within Visual Studio Code. To create this file, copy the
107+
``.env.template`` file to ``.env`` (and eventually add your own paths).

0 commit comments

Comments
 (0)