docs: Remove block quotes (#4621)
Removes the indents that cause the text to be interpreted as block quotesmaster
Sebastian Beckmann
GitHub
parent
2a7fd297e4
commit
8ec73aea86
|
|
@ -4,66 +4,66 @@ Contributing
|
|||
Quick Links for Contributing
|
||||
----------------------------
|
||||
|
||||
- Compiling and building OBS Studio:
|
||||
https://github.com/obsproject/obs-studio/wiki/Install-Instructions
|
||||
- Compiling and building OBS Studio:
|
||||
https://github.com/obsproject/obs-studio/wiki/Install-Instructions
|
||||
|
||||
- Our bug tracker:
|
||||
https://github.com/obsproject/obs-studio/issues
|
||||
- Our bug tracker:
|
||||
https://github.com/obsproject/obs-studio/issues
|
||||
|
||||
- Discord Server: https://obsproject.com/discord
|
||||
- Discord Server: https://obsproject.com/discord
|
||||
|
||||
- Development chat: #development on the Discord server (see above)
|
||||
- Development chat: #development on the Discord server (see above)
|
||||
|
||||
- Development forum:
|
||||
https://obsproject.com/forum/list/general-development.21/
|
||||
- Development forum:
|
||||
https://obsproject.com/forum/list/general-development.21/
|
||||
|
||||
- Developer/API Documentation:
|
||||
https://obsproject.com/docs
|
||||
- Developer/API Documentation:
|
||||
https://obsproject.com/docs
|
||||
|
||||
- To contribute language translations, do not make pull requests.
|
||||
Instead, use crowdin. Read here for more information:
|
||||
https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
|
||||
- To contribute language translations, do not make pull requests.
|
||||
Instead, use crowdin. Read here for more information:
|
||||
https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
|
||||
|
||||
Coding Guidelines
|
||||
-----------------
|
||||
|
||||
- OBS Studio uses kernel normal form (linux variant), for more
|
||||
information, please read here:
|
||||
https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst
|
||||
- OBS Studio uses kernel normal form (linux variant), for more
|
||||
information, please read here:
|
||||
https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst
|
||||
|
||||
- Avoid trailing spaces. To view trailing spaces before making a
|
||||
commit, use "git diff" on your changes. If colors are enabled for
|
||||
git in the command prompt, it will show you any whitespace issues
|
||||
marked with red.
|
||||
- Avoid trailing spaces. To view trailing spaces before making a
|
||||
commit, use "git diff" on your changes. If colors are enabled for
|
||||
git in the command prompt, it will show you any whitespace issues
|
||||
marked with red.
|
||||
|
||||
- Tabs for indentation, spaces for alignment. Tabs are treated as 8
|
||||
columns wide.
|
||||
- Tabs for indentation, spaces for alignment. Tabs are treated as 8
|
||||
columns wide.
|
||||
|
||||
- 80 columns max
|
||||
- 80 columns max
|
||||
|
||||
Commit Guidelines
|
||||
-----------------
|
||||
|
||||
- OBS Studio uses the 50/72 standard for commits. 50 characters max
|
||||
for the title (excluding module prefix), an empty line, and then a
|
||||
full description of the commit, wrapped to 72 columns max. See this
|
||||
link for more information: http://chris.beams.io/posts/git-commit/
|
||||
- OBS Studio uses the 50/72 standard for commits. 50 characters max
|
||||
for the title (excluding module prefix), an empty line, and then a
|
||||
full description of the commit, wrapped to 72 columns max. See this
|
||||
link for more information: http://chris.beams.io/posts/git-commit/
|
||||
|
||||
- Make sure commit titles are always in present tense, and are not
|
||||
followed by punctuation.
|
||||
- Make sure commit titles are always in present tense, and are not
|
||||
followed by punctuation.
|
||||
|
||||
- Prefix each commit's titles with the module name, followed by a colon
|
||||
and a space (unless modifying a file in the base directory). After
|
||||
that, the first word should be capitalized.
|
||||
- Prefix each commit's titles with the module name, followed by a colon
|
||||
and a space (unless modifying a file in the base directory). After
|
||||
that, the first word should be capitalized.
|
||||
|
||||
So for example, if you are modifying the obs-ffmpeg plugin::
|
||||
So for example, if you are modifying the obs-ffmpeg plugin::
|
||||
|
||||
obs-ffmpeg: Fix bug with audio output
|
||||
obs-ffmpeg: Fix bug with audio output
|
||||
|
||||
Or for libobs::
|
||||
Or for libobs::
|
||||
|
||||
libobs: Fix source not displaying
|
||||
libobs: Fix source not displaying
|
||||
|
||||
Note: When modifying cmake modules, just prefix with "cmake".
|
||||
Note: When modifying cmake modules, just prefix with "cmake".
|
||||
|
||||
- If you still need examples, please view the commit history.
|
||||
- If you still need examples, please view the commit history.
|
||||
|
|
|
|||
58
README.rst
58
README.rst
|
|
@ -16,51 +16,51 @@ OBS Studio <https://obsproject.com>
|
|||
What is OBS Studio?
|
||||
-------------------
|
||||
|
||||
OBS Studio is software designed for capturing, compositing, encoding,
|
||||
recording, and streaming video content, efficiently.
|
||||
OBS Studio is software designed for capturing, compositing, encoding,
|
||||
recording, and streaming video content, efficiently.
|
||||
|
||||
It's distributed under the GNU General Public License v2 (or any later
|
||||
version) - see the accompanying COPYING file for more details.
|
||||
It's distributed under the GNU General Public License v2 (or any later
|
||||
version) - see the accompanying COPYING file for more details.
|
||||
|
||||
Quick Links
|
||||
-----------
|
||||
|
||||
- Website: https://obsproject.com
|
||||
- Website: https://obsproject.com
|
||||
|
||||
- Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
|
||||
- Help/Documentation/Guides: https://github.com/obsproject/obs-studio/wiki
|
||||
|
||||
- Forums: https://obsproject.com/forum/
|
||||
- Forums: https://obsproject.com/forum/
|
||||
|
||||
- Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
|
||||
- Build Instructions: https://github.com/obsproject/obs-studio/wiki/Install-Instructions
|
||||
|
||||
- Developer/API Documentation: https://obsproject.com/docs
|
||||
- Developer/API Documentation: https://obsproject.com/docs
|
||||
|
||||
- Donating/backing/sponsoring: https://obsproject.com/contribute
|
||||
- Donating/backing/sponsoring: https://obsproject.com/contribute
|
||||
|
||||
- Bug Tracker: https://github.com/obsproject/obs-studio/issues
|
||||
- Bug Tracker: https://github.com/obsproject/obs-studio/issues
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
- If you wish to contribute code to the project, please make sure to
|
||||
read the coding and commit guidelines:
|
||||
https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
|
||||
- If you wish to contribute code to the project, please make sure to
|
||||
read the coding and commit guidelines:
|
||||
https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst
|
||||
|
||||
- Developer/API documentation can be found here:
|
||||
https://obsproject.com/docs
|
||||
- Developer/API documentation can be found here:
|
||||
https://obsproject.com/docs
|
||||
|
||||
- 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/
|
||||
- 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
|
||||
defer to the official help or official channels.
|
||||
- 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
|
||||
defer to the official help or official channels.
|
||||
|
|
|
|||
Loading…
Reference in New Issue