Files
rocm-systems/projects/rocdecode/docs/install/rocDecode-build-and-install.rst
spolifroni-amd 67052ff454 made changes to installation and landing pages (#445)
* initial commit of changes to the installation and landing pages

* deleted original install; fixed the toc; fixed typos

* fixed some wording issues; fixed some formatting issues

* adding back install.rst to try to fix the conflict

---------

Co-authored-by: Aryan Salmanpour <aryan.salmanpour@amd.com>

[ROCm/rocdecode commit: 6cc30f12a4]
2024-11-12 10:40:37 -05:00

56 líneas
2.1 KiB
ReStructuredText

.. meta::
:description: Build and install rocDecode with the source code
:keywords: install, building, rocDecode, AMD, ROCm, source code, developer
********************************************************************
Building and installing rocDecode from source code
********************************************************************
If you will be contributing to the rocDecode code base, or if you want to preview new features, build rocDecode from its source code.
If you will not be previewing features or contributing to the code base, use the :doc:`package installers <./rocDecode-package-install>` to install rocDecode.
Before building rocDecode, use `rocDecode-setup.py <https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py>`_ to install all the required prerequisites:
.. code:: shell
python3 rocDecode-setup.py [--rocm_path ROCM_INSTALLATION_PATH; default=/opt/rocm]
[--runtime {ON|OFF}; default=ON]
[--developer {ON|OFF}; default=OFF]
.. note::
Never run ``rocDecode-setup.py`` with ``--runtime OFF``.
``--developer ON`` is required to use the code samples.
Build and install rocDecode using the following commands:
.. code:: shell
git clone https://github.com/ROCm/rocDecode.git
cd rocDecode
mkdir build && cd build
cmake ../
make -j8
sudo make install
After installation, the rocDecode libraries will be copied to ``/opt/rocm/lib`` and the rocDecode header files will be copied to ``/opt/rocm/include/rocdecode``.
Build and install the rocDecode test module. This module is required if you'll be using the rocDecode samples, and can only be installed if ``rocDecode-setup.py`` was run with ``--developer ON``.
.. code:: shell
mkdir rocdecode-test && cd rocdecode-test
cmake /opt/rocm/share/rocdecode/test/
ctest -VV
Run ``make test`` to test your build. To run the test with the verbose option, run ``make test ARGS="-VV"``.
To create a package installer for rocDecode, run:
.. code:: shell
sudo make package