You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: installation.rst
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,22 +10,22 @@ There are three ways to install Conan:
10
10
11
11
1. The preferred and **strongly recommended way to install Conan** is from PyPI, the Python Package Index, using the ``pip`` command.
12
12
2. There are other available installers for different systems, which might come with a bundled python interpreter, so that you don't have to
13
-
install python first. Please note that some of **these installers might have some limitations**, specially those created with pyinstaller
13
+
install python first. Note that some of **these installers might have some limitations**, specially those created with pyinstaller
14
14
(such as Windows exe & Linux deb).
15
-
3. Running conan from sources.
15
+
3. Running Conan from sources.
16
16
17
17
Install with pip (recommended)
18
18
------------------------------
19
19
20
-
To install Conan using ``pip``, you need a python 2.7 or 3.X distribution installed in your machine. Modern python distros come
20
+
To install Conan using ``pip``, you need Python 2.7 or 3.X distribution installed on your machine. Modern Python distros come
21
21
with pip pre-installed. However, if necessary you can install pip by following the instructions in `pip docs`_.
22
22
23
23
.. warning::
24
24
25
-
Python 2 will by deprecated soon by the Python maintainers. It is strongly recommended to use Python 3 for conan, especially if need to manage non-ascii filenames or file contents.
26
-
Conan still supports Python 2, but some of the dependencies have started to be Python 3 only too. The roadmap for deprecating Python 2 support in Conan will be defined soon.
25
+
Python 2 will soon be deprecated by the Python maintainers. It is strongly recommended to use Python 3 with Conan, especially if need to manage non-ascii filenames or file contents.
26
+
Conan still supports Python 2, however some of the dependencies have started to be supported only by Python 3. The roadmap for deprecating Python 2 support in Conan will be defined soon.
27
27
28
-
Install conan:
28
+
Install Conan:
29
29
30
30
.. code-block:: bash
31
31
@@ -35,20 +35,20 @@ Install conan:
35
35
36
36
**Please READ carefully**
37
37
38
-
- Make sure that your **pip** installation matches your **python (2.7 or 3.X)** one.
39
-
- In Linux if you want to install it globally, you might need **sudo** permissions.
40
-
- We strongly recommend using **virtualenvs** (virtualenvwrapper works great) for everything python related
41
-
- In **Windows** and with Python 2.7, you might need to use **32bits** python distribution (which is the Windows default one), instead
42
-
of 64 bits.
43
-
- In **OSX**, specially latest versions that might have **System Integrity Protection**, pip might fail. Try with virtualenvs, or
44
-
install with other user ``$ pip install --user conan``.
45
-
- If you are in Windows, and using python <3.5, you might have problems if python is installed in a path with spaces, like
46
-
"C:/Program Files(x86)/Python". This is a known python's limitation, not Conan's. Install python in a path without spaces, use a
47
-
virtualenv in another location or upgrade your python installation.
48
-
- In some Linux distros, like Linux Mint, it is possible that you need a restart (shell restart, or logout/system if not enough) after
38
+
- Make sure that your **pip** installation matches your **Python (2.7 or 3.X)** version.
39
+
- In **Linux**, you may need **sudo** permissions to install Conan globally.
40
+
- We strongly recommend using **virtualenvs** (virtualenvwrapper works great) for everything related to Python.
41
+
- In **Windows** and Python 2.7, you may need to use **32bit** python distribution (which is the Windows default), instead
42
+
of 64 bit.
43
+
- In **OSX**, especially the latest versions that may have **System Integrity Protection**, pip may fail. Try using virtualenvs, or
44
+
install with another user ``$ pip install --user conan``.
45
+
- If you are using Windows and Python <3.5, you may have issues if Python is installed in a path with spaces, such as
46
+
"C:/Program Files(x86)/Python". This is a known Python limitation, and is not related to Conan. Try installing Python in a path without spaces, use a
47
+
virtualenv in another location or upgrade your Python installation.
48
+
- Some Linux distros, such as Linux Mint, require a restart (shell restart, or logout/system if not enough) after
49
49
installation, so Conan is found in the path.
50
-
- Windows, Python 3 installation can fail installing the ``wrapt`` dependency because a bug in **pip**. Information about the issue and
51
-
workarounds is here: https://github.com/GrahamDumpleton/wrapt/issues/112.
50
+
- Windows, Python 3 installation can fail installing the ``wrapt`` dependency because of a bug in **pip**. Information about this issue and
51
+
workarounds is available here: https://github.com/GrahamDumpleton/wrapt/issues/112.
52
52
53
53
Install from brew (OSX)
54
54
-----------------------
@@ -90,13 +90,13 @@ Execute the installer. You don't need to install python.
90
90
Initial configuration
91
91
---------------------
92
92
93
-
Let's check if conan is correctly installed. In your console, run the following:
93
+
Check if Conan is installed correctly. Run the following command in your console:
94
94
95
95
.. code-block:: bash
96
96
97
97
$ conan
98
98
99
-
You will see something similar to:
99
+
The response should be similar to:
100
100
101
101
.. code-block:: bash
102
102
@@ -110,7 +110,7 @@ You will see something similar to:
110
110
Install from source
111
111
-------------------
112
112
113
-
You can run conan directly from source code. First you need to install Python 2.7 or Python 3 and
113
+
You can run Conan directly from source code. First, you need to install Python 2.7 or Python 3 and
114
114
pip.
115
115
116
116
Clone (or download and unzip) the git repository and install its requirements:
0 commit comments