update docs

README.md

@@ -77,10 +77,12 @@ Requirements
 
 This goes over requirements for usage, for development requirements please visit the [docs](https://photoshopapi.readthedocs.io/).
 
-- A CPU with AVX2 support (this is most CPUs after 2014). If you are unsure, please refer to your CPUs specification
+- A CPU with AVX2 support (this is most CPUs after 2014) will greatly increase performance, if we detect this to not be there we disable this optimization
 - A 64-bit system
-- C++ Library: **Linux**, **Windows** or **MacOS** (M-Chips are not tested)
-- Python Library<sup>1</sup>: **Linux**, **Windows**, **MacOS** (M-Chips are not tested)
+- C++ Library: **Linux**, **Windows** or **MacOS**
+- Python Library<sup>1</sup>: **Linux**, **Windows**, **MacOS**
+
+The python bindings support python >=3.7 (except for ARM-based MacOS machines which raise this to >=3.10)
 
 > <sup>1</sup> Currently Linux is supported only as manylinux build and has some features disabled such as timestamps on logging.
 

docs/doxygen/building.rst

@@ -3,27 +3,23 @@
 Building and Using
 ===================
 
-.. note::
- Currently the PhotoshopAPI is only tested on Windows but nothing should speak against building it on Linux. 
-
-
 Contributions to the PhotoshopAPI are more than welcome, below you can find a quickstart guide for pulling the repository and building it as well as some additional notes on
 building the docs if required.
 
 
 Using the pre-built binaries
 ----------------------------
 
-The easiest way to get started with the PhotoshopAPI is with the pre-built binaries (currently only for windows) for each of the releases on the `github <https://github.com/EmilDohne/PhotoshopAPI/releases>`_ 
-page. Simply make sure you have the ``include/`` directory in your header include paths and the ``PhotoshopAPI.lib`` on your linker path
+The easiest way to get started with the PhotoshopAPI is with the pre-built binaries for each of the releases on the `github <https://github.com/EmilDohne/PhotoshopAPI/releases>`_ 
+page. Simply make sure you have the ``include/`` directory in your header include paths and the ``PhotoshopAPI.lib`` (or ``libPhotoshopAPI.o`` for linux/macos) on your linker path
 
 Building the PhotoshopAPI
 ---------------------------
 
 The PhotoshopAPI currently only builds to a static lib to be included into your project. There are 2 main routes of using it in your project, :ref:`submoduling` using CMake or :ref:`compiling`.
 
 We include all the necessary dependencies directly in the repository which is pulled by github when using the ``--recursive`` git flag. The only exception to this is when building the docs, see 
-:ref:`buildingdocs` for more information. Usually this shouldnt be necessary though and that build path can be disabled with the CMake flag ``PSAPI_BUILD_DOCS``. 
+:ref:`buildingdocs` for more information. Usually this shouldnt be necessary though and that build path can be disabled by passing ``-DPSAPI_BUILD_DOCS=OFF`` to cmake. 
 
 It is recommended to turn off everything but ``PSAPI_BUILD_STATIC`` when building from source. See below for a list of all flags available.
 
@@ -41,13 +37,13 @@ Build the tests associated with the PhotoshopAPI
 ``PSAPI_BUILD_EXAMPLES``: default ``ON``
 Build the examples associated with the PhotoshopAPI
 
-``PSAPI_BUILD_BENCHMARKS``: default ``ON``
+``PSAPI_BUILD_BENCHMARKS``: default ``OFF``
 Build the benchmarks associated with the PhotoshopAPI
 
-``PSAPI_BUILD_DOCS``: default ``ON``
+``PSAPI_BUILD_DOCS``: default ``OFF``
 Builds the documentation, requires some external installs which are documented at :ref:`buildingdocs`
 
-``PSAPI_BUILD_PYTHON``: default ``ON``
+``PSAPI_BUILD_PYTHON``: default ``OFF``
 Builds the python bindings associated with the PhotoshopAPI
 
 
@@ -138,4 +134,14 @@ local testing as the bindings are hosted on PyPi and can be installed with
 
 .. code-block:: console
 
- $ py -m pip install PhotoshopAPI
+ $ py -m pip install PhotoshopAPI
+
+Below you can find the full build steps for the python bindings:
+
+.. code-block:: console
+
+ $ cd <dir/to/PhotoshopAPI>
+ $ cmake -B <dir/to/PhotoshopAP>/bin -DCMAKE_BUILD_TYPE=Release -DPSAPI_BUILD_PYTHON=ON
+ $ cmake --build <dir/to/PhotoshopAP>/bin --config Release
+
+This will produce ``<dir/to/PhotoshopAP>/bin/PhotoshopAPI/x64-Release/python/*.pyd`` which is the compiled python source code that can be imported. The wheels are built using CI.

docs/doxygen/index.rst

@@ -67,10 +67,12 @@ Requirements
 
 This goes over requirements for usage, for development requirements please visit the :ref:`building` section.
 
-- A CPU with AVX2 support (this is most CPUs after 2014). If you are unsure, please refer to your CPUs specification
-- A 64-bit system
-- C++ Library: **Linux**, **Windows** or **MacOS** (M-Chips are not tested)
-- Python Library :sup:`1`: **Linux**, **Windows**, **MacOS** (M-Chips are not tested)
+- A CPU with AVX2 support (this is most CPUs after 2014) will greatly increase performance, if we detect this to not be there we disable this optimization
+- C++ Library: **Linux**, **Windows** or **MacOS** 
+- Python Library :sup:`1`: **Linux**, **Windows**, **MacOS**
+
+The python bindings support python >=3.7 (except for ARM-based MacOS machines which raise this to >=3.10)
+
 
 .. note:: 
 

docs/doxygen/requirements.txt

@@ -3,4 +3,4 @@ sphinx==7.2.6
 furo==2023.9.10
 sphinx-inline-tabs==2023.4.21
 numpydoc==1.6.0
-PhotoshopAPI>=0.3.0
+PhotoshopAPI>=0.4.0