Added .env.template

PlotPyStack · Nov 23, 2023 · 42df30f · 42df30f
1 parent 1875929
commit 42df30f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/.env → .env.template b/.env → .env.template
diff --git a/doc/dev/contribute.rst b/doc/dev/contribute.rst
@@ -93,9 +93,15 @@ development environment. The easiest way to do this is to use `virtualenv
 <http://pypi.python.org/pypi/virtualenv>`_ and `pip
 <http://pypi.python.org/pypi/pip>`_.
 
-Some environment variables are required to be set before using the project from
-within Visual Studio Code (used in `launch.json` and `tasks.json`). These are:
+Some parameters are required to be set before using the project from within
+Visual Studio Code (used in `launch.json` and `tasks.json`). These are:
 
 * ``PPSTACK_PYTHONEXE``: The path to the Python interpreter to use. This is
   used to launch the application from within Visual Studio Code. If not set,
   the default Python interpreter will be used.
+
+* `.env` file: This file is used to set environment variables for the
+  application. It is used to set the ``PYTHONPATH`` environment variable to
+  the root of the project. This is required to be able to import the project
+  modules from within Visual Studio Code. To create this file, copy the
+  ``.env.template`` file to ``.env`` (and eventually add your own paths).