Skip to content

Commit 41731bb

Browse files
committed
Improve README/CONTRIBUTING files
Use reStructuredText to allow HTML formatting while still maintaining clarity in the raw text.
1 parent b63e4b0 commit 41731bb

File tree

4 files changed

+134
-238
lines changed

4 files changed

+134
-238
lines changed

CONTRIBUTING

-64
This file was deleted.

CONTRIBUTING.rst

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
Contributing
2+
============
3+
4+
Quick Links for Contributing
5+
----------------------------
6+
7+
- Compiling and building OBS Studio:
8+
https://github.com/jp9000/obs-studio/wiki/Install-Instructions
9+
10+
- Our bug tracker (linked to forum accounts):
11+
https://obsproject.com/mantis/
12+
13+
- Development IRC channel: #obs-dev on QuakeNet
14+
15+
- Development forum:
16+
https://obsproject.com/forum/list/general-development.21/
17+
18+
- To contribute language translations, do not make pull requests.
19+
Instead, use crowdin. Read here for more information:
20+
https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
21+
22+
Coding Guidelines
23+
-----------------
24+
25+
- OBS Studio uses kernel normal form (linux variant), for more
26+
information, please read here:
27+
https://www.kernel.org/doc/Documentation/CodingStyle
28+
29+
- Avoid trailing spaces. To view trailing spaces before making a
30+
commit, use "git diff" on your changes. If colors are enabled for
31+
git in the command prompt, it will show you any whitespace issues
32+
marked with red.
33+
34+
- Tabs for indentation, spaces for alignment. Tabs are treated as 8
35+
columns wide.
36+
37+
- 80 columns max
38+
39+
Commit Guidlines
40+
----------------
41+
42+
- OBS Studio uses the 50/72 standard for commits. 50 characters max
43+
for the title (excluding module prefix), an empty line, and then a
44+
full description of the commit, wrapped to 72 columns max. See this
45+
link for more information: http://chris.beams.io/posts/git-commit/
46+
47+
- Make sure commit titles are always in present tense, and are not
48+
followed by punctuation.
49+
50+
- Prefix commit titles with the module name, followed by a colon and a
51+
space (unless modifying a file in the base directory). When
52+
modifying cmake modules, prefix with "cmake". So for example, if you
53+
are modifying the obs-ffmpeg plugin::
54+
55+
obs-ffmpeg: Fix bug with audio output
56+
57+
Or for libobs::
58+
59+
libobs: Fix source not displaying
60+
61+
- If you still need examples, please view the commit history.
62+
63+
Headers
64+
-------
65+
66+
There's no formal documentation as of yet, so it's recommended to read
67+
the headers (which are heavily commented) to learn the API.
68+
69+
Here are the most important headers to check out::
70+
71+
libobs/obs.h Main header
72+
73+
libobs/obs-module.h Main header for plugin modules
74+
75+
libobs/obs-source.h Creating video/audio sources
76+
77+
libobs/obs-output.h Creating outputs
78+
79+
libobs/obs-encoder.h Implementing encoders
80+
81+
libobs/obs-service.h Implementing custom streaming services
82+
83+
libobs/graphics/graphics.h Graphics API
84+
85+
UI/obs-frontend-api/obs-frontend-api.h
86+
Front-end API
87+
88+
If you would like to learn from example, examine the default plugins
89+
(in the <plugins> subdirectory). All features of OBS Studio are
90+
implemented as plugins.

README

-174
This file was deleted.

README.rst

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

0 commit comments

Comments
 (0)