README.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. OBS Studio <https://obsproject.com>
  2. ===================================
  3. .. image:: https://github.com/obsproject/obs-studio/actions/workflows/push.yaml/badge.svg?branch=master
  4. :alt: OBS Studio Build Status - GitHub Actions
  5. :target: https://github.com/obsproject/obs-studio/actions/workflows/push.yaml?query=branch%3Amaster
  6. .. image:: https://badges.crowdin.net/obs-studio/localized.svg
  7. :alt: OBS Studio Translation Project Progress
  8. :target: https://crowdin.com/project/obs-studio
  9. .. image:: https://img.shields.io/discord/348973006581923840.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
  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://github.com/obsproject/obs-studio/issues
  27. Contributing
  28. ------------
  29. - If you would like to help fund or sponsor the project, you can do so
  30. via `Patreon <https://www.patreon.com/obsproject>`_, `OpenCollective
  31. <https://opencollective.com/obsproject>`_, or `PayPal
  32. <https://www.paypal.me/obsproject>`_. See our `contribute page
  33. <https://obsproject.com/contribute>`_ for more information.
  34. - If you wish to contribute code to the project, please make sure to
  35. read the coding and commit guidelines:
  36. https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
  37. - Developer/API documentation can be found here:
  38. https://obsproject.com/docs
  39. - If you wish to contribute translations, do not submit pull requests.
  40. Instead, please use Crowdin. For more information read this page:
  41. https://obsproject.com/wiki/How-To-Contribute-Translations-For-OBS
  42. - Other ways to contribute are by helping people out with support on
  43. our forums or in our community chat. Please limit support to topics
  44. you fully understand -- bad advice is worse than no advice. When it
  45. comes to something that you don't fully know or understand, please
  46. defer to the official help or official channels.
  47. SAST Tools
  48. ----------
  49. `PVS-Studio <https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source>`_ - static analyzer for C, C++, C#, and Java code.