diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 78a9433..cd7d524 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -10,6 +10,20 @@ You will need Python 3.7 - 3.10 (64-bit) as well as Linux/macOS ~~~~~~~~~~~ +You will need to install some additional dependencies on Linux and macOS. +Primarily CMake, and Boost. + +On Ubuntu/Debian you can install these dependencies by running: +.. code-block:: bash + + sudo apt-get install cmake libboost-all-dev + +On macOS you can install them using Homewbrew by running: + +.. code-block:: bash + + brew install cmake boost + .. _linux-macos-install-pip: Install using pip @@ -22,6 +36,14 @@ Install using pip # or run the following if you already have camel_tools installed pip install camel-tools --upgrade +On Apple silicon Macs you may have to run the following instead: + +.. code-block:: bash + + CMAKE_OSX_ARCHITECTURES=arm64 pip install camel-tools + + # or run the following if you already have camel_tools installed + CMAKE_OSX_ARCHITECTURES=arm64 pip install camel-tools --upgrade .. _linux-macos-install-source: