Difference between revisions of "Getting Started At Coding"

From VideoLAN Wiki
Jump to navigation Jump to search
Line 17: Line 17:
 
First, read the [[VLC_source_tree|source tree explanation]] and the [[Modules_source_tree|module tree explanation]].
 
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.]]
+
Then, read the beginning of the  [[Hacker_Guide/Core|introduction to VLC's core]] and the [[Documentation:VLC_Modules_Loading|modules loading documentation.]]
  
 
Before sending a patch be sure to read [[Sending Patch]].
 
Before sending a patch be sure to read [[Sending Patch]].

Revision as of 11:53, 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.

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.

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.

Before sending a patch be sure to read Sending Patch.

To correctly report a bug see Report bugs.