From 873bf1074d26e4c78e7b61975e881a0c8954d2ba Mon Sep 17 00:00:00 2001 From: Bonan Zhu <33688599+zhubonan@users.noreply.github.com> Date: Fri, 20 Aug 2021 09:43:04 +0100 Subject: [PATCH] Update README.rst Update the instructions for installation: - use the https link for cloning - otherwise it does not work for those not having ssh public key access. - `pip install` should not have the `--user` options, as most likely it is going to be installed into a virtual environment. --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c1fcbf6..5826a63 100644 --- a/README.rst +++ b/README.rst @@ -45,9 +45,9 @@ ThermoPlotter can easily be installed with git and pip: .. code-block:: bash - git clone git@github.com:SMTG-UCL/ThermoPlotter.git + git clone https://github.com/SMTG-UCL/ThermoPlotter.git cd ThermoPlotter - python3 -m pip install --user . + pip install . After installing, you may want to copy ``ThermoPlotter/tprc.yaml`` to ``~/.config/tprc.yaml``, if you want to set your own default axis