Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for CMake flags #224

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/overview/build-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,20 @@ Compile Flags
* - -DKOMPUTE_DISABLE_SHADER_UTILS
- Disable the shader utils and skip adding glslang as dependency

Other CMake Flags
~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1

* - Flag
- Description
* - -DPYTHON_INCLUDE_DIR
- Path to where Python.h is found, used for specifying installation of Python (see `this PR <https://github.com/EthicalML/vulkan-kompute/pull/222>`_)
* - -DPYTHON_LIBRARY
- Path to the Python library, used for specifying installation of Python (see `this PR <https://github.com/EthicalML/vulkan-kompute/pull/222>`_)
* - -DCMAKE_OSX_ARCHITECTURES
- Specifies the target architecture for Apple platforms (see `this issue <https://github.com/EthicalML/vulkan-kompute/issues/223>`_)

Dependencies
^^^^^^^^^^^^
Expand Down