README.rst 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. OBS Studio <https://obsproject.com>
  2. ===================================
  3. .. image:: https://travis-ci.org/obsproject/obs-studio.svg?branch=master
  4. :alt: OBS Studio Build Status - Travis CI
  5. :target: https://travis-ci.org/obsproject/obs-studio
  6. .. image:: https://ci.appveyor.com/api/projects/status/github/obsproject/obs-studio?branch=master&svg=true
  7. :alt: OBS Studio Build Status - AppVeyor CI
  8. :target: https://ci.appveyor.com/project/jp9000/obs-studio/branch/master
  9. .. image:: https://dev.azure.com/obsjim/obsjim/_apis/build/status/obsproject.obs-studio?branchName=master
  10. :alt: OBS Studio Build Status - Azure Pipelines
  11. :target: https://dev.azure.com/obsjim/obsjim/_build/latest?definitionId=1&branchName=master
  12. .. image:: https://discordapp.com/api/guilds/348973006581923840/widget.png?style=shield
  13. :alt: OBS Studio Discord Server
  14. :target: https://obsproject.com/discord
  15. What is OBS Studio?
  16. -------------------
  17. OBS Studio is software designed for capturing, compositing, encoding,
  18. recording, and streaming video content, efficiently.
  19. It's distributed under the GNU General Public License v2 (or any later
  20. version) - see the accompanying COPYING file for more details.
  21. Quick Links
  22. -----------
  23. - Website: https://obsproject.com
  24. - Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
  25. - Forums: https://obsproject.com/forum/
  26. - Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
  27. - Developer/API Documentation: https://obsproject.com/docs
  28. - Donating/backing/sponsoring: https://obsproject.com/contribute
  29. - Bug Tracker: https://obsproject.com/mantis/
  30. (Note: The bug tracker is linked to forum accounts. To use the bug
  31. tracker, log in to a forum account)
  32. Contributing
  33. ------------
  34. - If you would like to help fund or sponsor the project, you can do so
  35. via `Patreon <https://www.patreon.com/obsproject>`_, `OpenCollective
  36. <https://opencollective.com/obsproject>`_, or `PayPal
  37. <https://www.paypal.me/obsproject>`_. See our `contribute page
  38. <https://obsproject.com/contribute>`_ for more information.
  39. - If you wish to contribute code to the project, please make sure to
  40. read the coding and commit guidelines:
  41. https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
  42. - Developer/API documentation can be found here:
  43. https://obsproject.com/docs
  44. - If you wish to contribute translations, do not submit pull requests.
  45. Instead, please use Crowdin. For more information read this thread:
  46. https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
  47. - Other ways to contribute are by helping people out with support on
  48. our forums or in our community chat. Please limit support to topics
  49. you fully understand -- bad advice is worse than no advice. When it
  50. comes to something that you don't fully know or understand, please
  51. defer to the official help or official channels.