README.rst 2.5 KB

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