Skip to content

Commit d7c6fe3

Browse files
committed
readme: Convert instruction into one code snippet, highlight venv use
1 parent 7209f7b commit d7c6fe3

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.rst

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,33 @@ default CWL interpreter installed on a host.
2626
Install
2727
-------
2828

29-
Installing the official package from PyPi (will install "cwltool" package as
30-
well)::
29+
It is highly recommended to setup virtual environment before installing `cwltool`:
30+
31+
.. code:: bash
32+
33+
virtualenv -p python2 venv # Create a virtual environment, can use `python3` as well
34+
source venv/bin/activate # Activate environment before installing `cwltool`
35+
36+
1. Installing the official package from PyPi (will install "cwltool" package as
37+
well)
38+
39+
.. code:: bash
3140
3241
pip install cwlref-runner
3342
34-
If installing alongside another CWL implementation then::
43+
If installing alongside another CWL implementation then
3544

45+
.. code:: bash
3646
pip install cwltool
3747
38-
To install from source
48+
2. To install from source
49+
50+
.. code:: bash
3951
40-
#. Install virtualenv via pip: ``pip install virtualenv``
41-
#. Clone the cwltool: ``git clone https://github.com/common-workflow-language/cwltool.git``
42-
#. Switch to cwltool directory: ``cd cwltool``
43-
#. Create a virtual environment: ``virtualenv -p python2 venv``, use ``python3`` if you want to use in Python 3 runtime.
44-
#. To begin using the virtual environment, it needs to be activated: ``source venv/bin/activate``
45-
#. Install cwltool in the virtual environment: ``pip install .``
46-
#. Check the version and make sure cwltool is invoked correctly: ``cwltool --version``
52+
git clone https://github.com/common-workflow-language/cwltool.git # clone cwltool repo
53+
cd cwltool # Switch to source directory
54+
pip install . # Install `cwltool` from source
55+
cwltool --version # Check if the installation works correctly
4756
4857
Remember, if co-installing multiple CWL implementations then you need to
4958
maintain which implementation ``cwl-runner`` points to via a symbolic file

0 commit comments

Comments
 (0)