README.rst 3.1 KB

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