From 313af857ab1a55f87430425a076e81253eb03d72 Mon Sep 17 00:00:00 2001 From: baldurk Date: Fri, 10 Feb 2017 12:12:10 +0000 Subject: [PATCH] Add README for linux binary distributions --- scripts/LINUX_DIST_README | 78 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 scripts/LINUX_DIST_README diff --git a/scripts/LINUX_DIST_README b/scripts/LINUX_DIST_README new file mode 100644 index 000000000..fb8d885b3 --- /dev/null +++ b/scripts/LINUX_DIST_README @@ -0,0 +1,78 @@ +About: +------ + +RenderDoc is a debugger for graphics APIs, currently supporting OpenGL +and Vulkan. This package contains the headless utility tool +'renderdoccmd' which can be used to capture applications, as well as a +work-in-progress version of the Qt UI 'qrenderdoc'. + +The directory structure in the package matches how it should be +installed, most commonly under /usr but this is up to you. + +After installation if you'd like to register the desktop files like +thumbnailer, shortcut, icons, etc, you'll need something along the lines +of these commands as root: + +# update-desktop-database +# update-menus +# update-mime-database /usr/share/mime/ +# gtk-update-icon-cache /usr/share/icons/hicolor/ + +Documentation is available online at https://renderdoc.org/docs and more +information in general is available on the github repository and wiki - +https://github.com/baldurk/renderdoc + + +Requirements: +------------- + +* libxcb +* libX11 +* libX11-xcb +* libGL + +These should be available on any system with X installed. You can always +build RenderDoc yourself from source. For more information, github. + +To run qrenderdoc, Qt is statically linked two additional system +libraries are needed: + +* libfontconfig +* libfreetype + +Vulkan Layer registration: +-------------------------- + +RenderDoc cannot capture Vulkan when run from binary without any +installation. Any installed package from a distribution or otherwise is +expected to have registered the Vulkan layer as appropriate, but if you +are running binaries loose then the renderdoccmd utility will prompt you +to register the layer. This involves placing an appropriate .json file +under $HOME/.local/vulkan, or optionally in /etc if desired (and if the +tool is run with appropriate permissions). + + +License: +-------- + +RenderDoc is distributed under the MIT licsense, both in binary form and +the source code itself. You can find the full detail including 3rd party +licenses in the source repository as LICENSE.md + + +Reporting bugs: +--------------- + +Bugs should be reported to the github bug tracker, +(https://github.com/baldurk/renderdoc/issues) or directly via email to +the maintainer - Baldur Karlsson - if the report +contains sensitive information or you don't have a github account. + + +Sending patches/contributions: +------------------------------ + +Please submit your contributions as pull requests on github +(https://github.com/baldurk/renderdoc). Please follow the CONTRIBUTING +guidelines available in the repository regarding code formatting with +clang-format and commit message formatting.