README.rst 2.7 KB

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