Difference between revisions of "Getting Started At Coding"
| Line 8: | Line 8: | ||
All our community lives on our IRC channel: #videolan on freenode. Joining is '''strongly''' advised. | All our community lives on our IRC channel: #videolan on freenode. Joining is '''strongly''' advised. | ||
| − | + | To correctly report a bug see [[Report bugs]]. | |
== Get the Code == | == Get the Code == | ||
| Line 21: | Line 21: | ||
Then, read the beginning of the [[Hacker_Guide/Core|introduction to VLC's core]] and the [[Documentation:VLC_Modules_Loading|modules loading documentation.]] | Then, read the beginning of the [[Hacker_Guide/Core|introduction to VLC's core]] and the [[Documentation:VLC_Modules_Loading|modules loading documentation.]] | ||
| + | == Coding == | ||
Before sending a patch be sure to read [[Sending Patch]]. | Before sending a patch be sure to read [[Sending Patch]]. | ||
| − | + | 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. | |
[[Category:Coding]] | [[Category:Coding]] | ||
Revision as of 11:55, 27 September 2012
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 freenode. Joining is strongly advised.
To correctly report a bug see Report bugs.
Get the Code
Start by building VLC and use Git to get the full source code.
You should also know how to compile VLC.
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.
Coding
Before sending a patch be sure to read Sending Patch.
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.
