diff --git a/docs/source/_static/rez-gui1.png b/docs/source/_static/rez-gui1.png new file mode 100644 index 000000000..021eca651 Binary files /dev/null and b/docs/source/_static/rez-gui1.png differ diff --git a/docs/source/_static/rez-gui2.png b/docs/source/_static/rez-gui2.png new file mode 100644 index 000000000..13aa353e3 Binary files /dev/null and b/docs/source/_static/rez-gui2.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index 1d31a1689..5fcfc7251 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,6 +33,7 @@ Welcome to rez's documentation! pip plugins package_orderers + rez_gui .. toctree:: :maxdepth: 2 diff --git a/docs/source/rez_gui.rst b/docs/source/rez_gui.rst new file mode 100644 index 000000000..9cd270c91 --- /dev/null +++ b/docs/source/rez_gui.rst @@ -0,0 +1,67 @@ +======= +Rez GUI +======= + +Rez GUI is for opening context files, re-resolving them, graphically reviewing the diffs, +making alterations to the context file, graphing your solve, seeing conflicts, etc. + +It’s not intended as an entrypoint into resolves, more like a diagnostic/debug tool that is +sometimes more user-friendly than interpreting an error on the CLI. + +Rez GUI is NOT intended to be a software launcher that can be used by non-technical artists +in your studio. + +Reference Images +================ + +.. image:: _static/rez-gui1.png + :align: center + :class: rez-diagram + :target: _static/rez-gui1.png + +.. image:: _static/rez-gui2.png + :align: center + :class: rez-diagram + :target: _static/rez-gui2.png + +Installation +============ + +To start, we need to install either PySide or PyQt to Rez's virtual Python environment. + +.. note:: + The following install instructions have only been tested with Python versions 3.5 to 3.10. + + If you want to use a newer Python version, you will be unable to install PySide2 from PyPi + and will need to build from source. + +We have not tested rez-gui with Qt 6 yet, so any following commands will use Qt 5 packages. + +To install PySide2 on the Windows commandline: + +.. code-block:: console + + $ /Scripts/pip install PySide2 + +To install PySide2 on Mac/Linux commandline: + +.. code-block:: console + + $ /bin/pip install PySide2 + +rez-gui also requires another Python package called ``Qt.py``. This is so that we can use any +flavor of Qt bindings for Python without changing code. + +To install `Qt.py` on the Windows commandline: + +.. code-block:: console + + $ /Scripts/pip install Qt.py + +To install `Qt.py` on the Mac/Linux commandline: + +.. code-block:: console + + $ /bin/pip install Qt.py + +Now, rez-gui has all of its dependencies installed, and you can run rez-gui.