Difference between revisions of "Getting Started At Coding"
(→Code) |
|||
| (13 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
== Introduction to VLC development == | == Introduction to VLC development == | ||
| Line 6: | Line 7: | ||
Therefore we advise everyone who makes changes to the VLC sourcecode, to sign up with the [http://www.videolan.org/support/lists.html vlc-devel mailing-list] so you can keep up with the latest changes and developments. | Therefore we advise everyone who makes changes to the VLC sourcecode, to sign up with the [http://www.videolan.org/support/lists.html vlc-devel mailing-list] so you can keep up with the latest changes and developments. | ||
| − | + | All our community lives on our IRC channel: #videolan on libera.chat. Joining is '''strongly''' advised. | |
| + | |||
| + | If you need to report a bug, please read the [[report bugs|reporting bugs documentation]]. | ||
== Get the Code == | == Get the Code == | ||
Start by building VLC and use [[Git]] to [[GetTheSource#How_to_get_VLC_media_player.27s_latest_source_tree|get the full source code]]. | Start by building VLC and use [[Git]] to [[GetTheSource#How_to_get_VLC_media_player.27s_latest_source_tree|get the full source code]]. | ||
| − | You should also know how to [[compile VLC]]. | + | You should also know how to [[compile VLC]] for your architecture. |
== Understand the Code == | == Understand the Code == | ||
| + | |||
| + | First, read the [[VLC_source_tree|source tree explanation]] and the [[Modules_source_tree|module tree explanation]]. | ||
| + | |||
| + | Then, read the beginning of the [[Hacker_Guide/Core|introduction to VLC's core]] and the [[Documentation:VLC_Modules_Loading|modules loading documentation.]] | ||
| + | |||
| + | You can find more information on IRC and in the [[Hacker Guide]]. | ||
| + | |||
| + | == Coding == | ||
| + | If you are looking for code ideas, please look at our [[Mini Projects]], our [https://trac.videolan.org/vlc/ Bug tracker], or ask on [[IRC]]. | ||
| + | |||
| + | Please try to keep to our [[Code_Conventions|code conventions]]. They are very simple and help to keep all code readable. When you write new stuff, especially core stuff (in the "src" or "include" folders), please comment it heavily or add doxygen documentation for your sources. | ||
Before sending a patch be sure to read [[Sending Patch]]. | Before sending a patch be sure to read [[Sending Patch]]. | ||
| − | |||
| − | |||
[[Category:Coding]] | [[Category:Coding]] | ||
Latest revision as of 12:48, 26 May 2021
Introduction to VLC development
VLC media player is a very popular project and is thus very fast changing and ever evolving project.
It is very important to keep up to date with the latest developments.
Therefore we advise everyone who makes changes to the VLC sourcecode, to sign up with the vlc-devel mailing-list so you can keep up with the latest changes and developments.
All our community lives on our IRC channel: #videolan on libera.chat. Joining is strongly advised.
If you need to report a bug, please read the reporting bugs documentation.
Get the Code
Start by building VLC and use Git to get the full source code.
You should also know how to compile VLC for your architecture.
Understand the Code
First, read the source tree explanation and the module tree explanation.
Then, read the beginning of the introduction to VLC's core and the modules loading documentation.
You can find more information on IRC and in the Hacker Guide.
Coding
If you are looking for code ideas, please look at our Mini Projects, our Bug tracker, or ask on IRC.
Please try to keep to our code conventions. They are very simple and help to keep all code readable. When you write new stuff, especially core stuff (in the "src" or "include" folders), please comment it heavily or add doxygen documentation for your sources.
Before sending a patch be sure to read Sending Patch.
