From 30b2d60cd28ed10174f09f13f228e19398255265 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1lint=20Aradi?= Date: Sat, 22 Jun 2024 17:27:02 +0200 Subject: [PATCH] Change readme to venv based cookiecutter installation --- README.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 52510c4..9aae998 100644 --- a/README.rst +++ b/README.rst @@ -22,12 +22,25 @@ Prerequisites You must have cookiecutter and Python installed on your system in order to generate Fortran projects with *Cookiecutter-Fortran-project*. If cookiecutter is not installed yet, you can obtain and install it using the pip installation -tool distributed with Python. For Linux users, this can be easily accomplished -with the command +tool distributed with Python. For Linux and macOS users, this can be easily +accomplished with the following commands: .. code-block:: - pip install --user cookiecutter + mkdir -p ~/opt/venv + python3 -m venv ~/opt/venv/cookiecutter + source ~/opt/venv/cookiecutter/bin/activate + pip install cookiecutter + +This installs cookiecutter in a virtual Python environment created in the +directory ``~/opt/venv/cookiecutter``. Note, that whenever you open a new shell, +you have to execute + +.. code-block:: + + source ~/opt/venv/cookiecutter/bin/activate + +first in order to obtain access to a installed Python cookiecutter script. For other operating systems and further ways of installing cookiecutter, consult the `cookiecutter installation instructions