From 60648d4a6354901ce49412f953191cc738c08c68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Corentin=20No=C3=ABl?= Date: Tue, 31 Aug 2021 11:44:06 +0200 Subject: [PATCH] Add simple README.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Corentin Noël Reviewed-by: Chia-I Wu --- README.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..343d7cc --- /dev/null +++ b/README.rst @@ -0,0 +1,50 @@ +`Virglrenderer `_ - The VirGL virtual OpenGL renderer +================================================================================== + + +Source +------ + +This repository lives at https://gitlab.freedesktop.org/virgl/virglrenderer. +Other repositories are likely forks, and code found there is not supported. + + +Build & install +--------------- + +This project uses the meson build system: + +.. code-block:: sh + + $ meson build + $ cd build + $ ninja install + + +Support +------- + +Many Virglrenderer devs hang on IRC; if you're not sure which channel is +appropriate, you should ask your question on `OFTC's #virgil3d +`_, someone will redirect you if +necessary. +Remember that not everyone is in the same timezone as you, so it might +take a while before someone qualified sees your question. + +The next best option is to ask your question in an email to the +mailing lists: `virglrenderer-devel\@lists.freedesktop.org +`_ + + +Bug reports +----------- + +If you think something isn't working properly, please file a bug report in +`GitLab `_. + + +Contributing +------------ + +Contributions are welcome, note that Virglrenderer uses GitLab for patches +submission, review and discussions.