Add simple README.rst

Signed-off-by: Corentin Noël <corentin.noel@collabora.com>
Reviewed-by: Chia-I Wu <olvaffe@gmail.com>
macos/master
Corentin Noël 3 years ago
parent 82a38504fe
commit 60648d4a63
  1. 50
      README.rst

@ -0,0 +1,50 @@
`Virglrenderer <https://virgil3d.github.io/>`_ - 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
<irc://irc.oftc.net/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
<https://lists.freedesktop.org/mailman/listinfo/virglrenderer-devel>`_
Bug reports
-----------
If you think something isn't working properly, please file a bug report in
`GitLab <https://gitlab.freedesktop.org/virgl/virglrenderer/-/issues>`_.
Contributing
------------
Contributions are welcome, note that Virglrenderer uses GitLab for patches
submission, review and discussions.
Loading…
Cancel
Save