README.rst 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. OBS Studio <https://obsproject.com>
  2. ===================================
  3. What is OBS Studio?
  4. -------------------
  5. OBS Studio is software designed for capturing, compositing, encoding,
  6. recording, and streaming video content, efficiently.
  7. It's distributed under the GNU General Public License v2 - see the
  8. accompanying COPYING file for more details.
  9. Quick Links
  10. -----------
  11. - Website: https://obsproject.com
  12. - Help/Documentation/Guides: https://github.com/jp9000/obs-studio/wiki
  13. - Forums: https://obsproject.com/forum/
  14. - Build Instructions: https://github.com/jp9000/obs-studio/wiki/Install-Instructions
  15. - Developer/API Documentation: https://obsproject.com/docs
  16. - Bug Tracker: https://obsproject.com/mantis/
  17. (Note: The bug tracker is linked to forum accounts. To use the bug
  18. tracker, log in to a forum account)
  19. Contributing
  20. ------------
  21. - If you wish to contribute code to the project, please make sure read
  22. the coding and commit guidelines:
  23. https://github.com/jp9000/obs-studio/blob/master/CONTRIBUTING.rst
  24. - Developer/API documentaiton can be found here:
  25. https://obsproject.com/docs
  26. - If you wish to contribute translations, do not submit pull requests.
  27. Instead, please use Crowdin. For more information read this thread:
  28. https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
  29. - Other ways to contribute are by helping people out with support on
  30. our forums or in our community chat. Please limit support to topics
  31. you fully understand -- bad advice is worse than no advice. When it
  32. comes to something that you don't fully know or understand, please
  33. defer to the official help or official channels.