README.rst 2.6 KB
Newer Older
J
jp9000 已提交
1 2 3
OBS Studio <https://obsproject.com>
===================================

4
.. image:: https://dev.azure.com/obsjim/obsjim/_apis/build/status/obsproject.obs-studio?branchName=master
R
Rodney 已提交
5 6
   :alt: OBS Studio Build Status - Azure Pipelines
   :target: https://dev.azure.com/obsjim/obsjim/_build/latest?definitionId=1&branchName=master
M
Matt Gajownik 已提交
7

V
Vainock 已提交
8 9 10 11
.. image:: https://d322cqt584bo4o.cloudfront.net/obs-studio/localized.svg
   :alt: OBS Studio Translation Project Progress
   :target: https://crowdin.com/project/obs-studio

R
Rodney 已提交
12 13 14 15
.. image:: https://discordapp.com/api/guilds/348973006581923840/widget.png?style=shield
   :alt: OBS Studio Discord Server
   :target: https://obsproject.com/discord

J
jp9000 已提交
16 17 18 19 20 21
What is OBS Studio?
-------------------

  OBS Studio is software designed for capturing, compositing, encoding,
  recording, and streaming video content, efficiently.

22 23
  It's distributed under the GNU General Public License v2 (or any later
  version) - see the accompanying COPYING file for more details.
J
jp9000 已提交
24 25 26 27 28 29

Quick Links
-----------

 - Website: https://obsproject.com

T
Taylor 已提交
30
 - Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
J
jp9000 已提交
31 32 33

 - Forums: https://obsproject.com/forum/

T
Taylor 已提交
34
 - Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
J
jp9000 已提交
35

J
jp9000 已提交
36 37
 - Developer/API Documentation: https://obsproject.com/docs

38 39
 - Donating/backing/sponsoring: https://obsproject.com/contribute

C
Clayton Groeneveld 已提交
40
 - Bug Tracker: https://github.com/obsproject/obs-studio/issues
J
jp9000 已提交
41 42 43 44

Contributing
------------

45 46 47 48 49 50
 - If you would like to help fund or sponsor the project, you can do so
   via `Patreon <https://www.patreon.com/obsproject>`_, `OpenCollective
   <https://opencollective.com/obsproject>`_, or `PayPal
   <https://www.paypal.me/obsproject>`_.  See our `contribute page
   <https://obsproject.com/contribute>`_ for more information.

B
Beau Russell 已提交
51 52
 - If you wish to contribute code to the project, please make sure to
   read the coding and commit guidelines:
T
Taylor 已提交
53
   https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
J
jp9000 已提交
54

J
jp9000 已提交
55
 - Developer/API documentation can be found here:
J
jp9000 已提交
56 57
   https://obsproject.com/docs

J
jp9000 已提交
58 59 60 61 62 63 64 65
 - If you wish to contribute translations, do not submit pull requests.
   Instead, please use Crowdin.  For more information read this thread:
   https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/

 - Other ways to contribute are by helping people out with support on
   our forums or in our community chat.  Please limit support to topics
   you fully understand -- bad advice is worse than no advice.  When it
   comes to something that you don't fully know or understand, please
J
jp9000 已提交
66
   defer to the official help or official channels.