Skip to content

Commit 65f93cd

Browse files
committed
Added additional installation instructions.
1 parent 2e27503 commit 65f93cd

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/source/getting_started.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,20 @@ You will need Python 3.7 - 3.10 (64-bit) as well as
1010
Linux/macOS
1111
~~~~~~~~~~~
1212

13+
You will need to install some additional dependencies on Linux and macOS.
14+
Primarily CMake, and Boost.
15+
16+
On Ubuntu/Debian you can install these dependencies by running:
17+
.. code-block:: bash
18+
19+
sudo apt-get install cmake libboost-all-dev
20+
21+
On macOS you can install them using Homewbrew by running:
22+
23+
.. code-block:: bash
24+
25+
brew install cmake boost
26+
1327
.. _linux-macos-install-pip:
1428

1529
Install using pip
@@ -22,6 +36,14 @@ Install using pip
2236
# or run the following if you already have camel_tools installed
2337
pip install camel-tools --upgrade
2438
39+
On Apple silicon Macs you may have to run the following instead:
40+
41+
.. code-block:: bash
42+
43+
CMAKE_OSX_ARCHITECTURES=arm64 pip install camel-tools
44+
45+
# or run the following if you already have camel_tools installed
46+
CMAKE_OSX_ARCHITECTURES=arm64 pip install camel-tools --upgrade
2547
2648
.. _linux-macos-install-source:
2749

0 commit comments

Comments
 (0)