Skip to content

Commit

Permalink
Change readme to venv based cookiecutter installation (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
aradi authored Jun 22, 2024
1 parent 73fce5f commit cc08c0d
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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. On Linux and macOS 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
in order to obtain access to the installed cookiecutter script.

For other operating systems and further ways of installing cookiecutter, consult
the `cookiecutter installation instructions
Expand Down

0 comments on commit cc08c0d

Please sign in to comment.