README.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. - Bug Tracker: https://obsproject.com/mantis/
  29. (Note: The bug tracker is linked to forum accounts. To use the bug
  30. tracker, log in to a forum account)
  31. Contributing
  32. ------------
  33. - If you wish to contribute code to the project, please make sure to
  34. read the coding and commit guidelines:
  35. https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
  36. - Developer/API documentation can be found here:
  37. https://obsproject.com/docs
  38. - If you wish to contribute translations, do not submit pull requests.
  39. Instead, please use Crowdin. For more information read this thread:
  40. https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
  41. - Other ways to contribute are by helping people out with support on
  42. our forums or in our community chat. Please limit support to topics
  43. you fully understand -- bad advice is worse than no advice. When it
  44. comes to something that you don't fully know or understand, please
  45. defer to the official help or official channels.
  46. Credits
  47. -------
  48. - Icons made by `Freepik <https://www.freepik.com>`_ from
  49. `Flaticon <https://www.flaticon.com/>`_ are licensed under
  50. `CC 3.0 BY <https://creativecommons.org/licenses/by/3.0/>`_.