Add documentation links
parent
66ec96d52c
commit
a6e90abd53
|
@ -60,31 +60,8 @@ Commit Guidlines
|
||||||
|
|
||||||
- If you still need examples, please view the commit history.
|
- If you still need examples, please view the commit history.
|
||||||
|
|
||||||
Headers
|
Developer Documentation
|
||||||
-------
|
-----------------------
|
||||||
|
|
||||||
There's no formal documentation as of yet, so it's recommended to read
|
Documentation is generated via sphinx, and can be found at
|
||||||
the headers (which are heavily commented) to learn the API.
|
https://obsproject.com/docs
|
||||||
|
|
||||||
Here are the most important headers to check out::
|
|
||||||
|
|
||||||
libobs/obs.h Main header
|
|
||||||
|
|
||||||
libobs/obs-module.h Main header for plugin modules
|
|
||||||
|
|
||||||
libobs/obs-source.h Creating video/audio sources
|
|
||||||
|
|
||||||
libobs/obs-output.h Creating outputs
|
|
||||||
|
|
||||||
libobs/obs-encoder.h Implementing encoders
|
|
||||||
|
|
||||||
libobs/obs-service.h Implementing custom streaming services
|
|
||||||
|
|
||||||
libobs/graphics/graphics.h Graphics API
|
|
||||||
|
|
||||||
UI/obs-frontend-api/obs-frontend-api.h
|
|
||||||
Front-end API
|
|
||||||
|
|
||||||
If you would like to learn from example, examine the default plugins
|
|
||||||
(in the <plugins> subdirectory). All features of OBS Studio are
|
|
||||||
implemented as plugins.
|
|
||||||
|
|
|
@ -15,12 +15,14 @@ Quick Links
|
||||||
|
|
||||||
- Website: https://obsproject.com
|
- Website: https://obsproject.com
|
||||||
|
|
||||||
- Help/Guides: https://github.com/jp9000/obs-studio/wiki
|
- Help/Documentation/Guides: https://github.com/jp9000/obs-studio/wiki
|
||||||
|
|
||||||
- Forums: https://obsproject.com/forum/
|
- Forums: https://obsproject.com/forum/
|
||||||
|
|
||||||
- Build Instructions: https://github.com/jp9000/obs-studio/wiki/Install-Instructions
|
- Build Instructions: https://github.com/jp9000/obs-studio/wiki/Install-Instructions
|
||||||
|
|
||||||
|
- Developer/API Documentation: https://obsproject.com/docs
|
||||||
|
|
||||||
- Bug Tracker: https://obsproject.com/mantis/
|
- Bug Tracker: https://obsproject.com/mantis/
|
||||||
|
|
||||||
(Note: The bug tracker is linked to forum accounts. To use the bug
|
(Note: The bug tracker is linked to forum accounts. To use the bug
|
||||||
|
@ -33,6 +35,9 @@ Contributing
|
||||||
the coding and commit guidelines:
|
the coding and commit guidelines:
|
||||||
https://github.com/jp9000/obs-studio/blob/master/CONTRIBUTING.rst
|
https://github.com/jp9000/obs-studio/blob/master/CONTRIBUTING.rst
|
||||||
|
|
||||||
|
- Developer/API documentaiton can be found here:
|
||||||
|
https://obsproject.com/docs
|
||||||
|
|
||||||
- If you wish to contribute translations, do not submit pull requests.
|
- If you wish to contribute translations, do not submit pull requests.
|
||||||
Instead, please use Crowdin. For more information read this thread:
|
Instead, please use Crowdin. For more information read this thread:
|
||||||
https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
|
https://obsproject.com/forum/threads/how-to-contribute-translations-for-obs.16327/
|
||||||
|
|
Loading…
Reference in New Issue