Difference between revisions of "Getting Started At Coding"

From VideoLAN Wiki
Jump to navigation Jump to search
(HACKING file is no more)
Line 10: Line 10:
  
 
Start by building VLC and use [[Git]] to get the full source code.
 
Start by building VLC and use [[Git]] to get the full source code.
 
+
You should also know how to [[compile VLC]].
Before you start be sure to read the '''[http://git.videolan.org/?p=vlc.git;a=blob;f=HACKING;hb=HEAD HACKING]''' file in the main VLC source directory.
 
  
 
Before sending a patch be sure to read [[Sending Patch]]. To correctly report a bug see [[Report bugs]].
 
Before sending a patch be sure to read [[Sending Patch]]. To correctly report a bug see [[Report bugs]].
  
 
[[Category:Coding]]
 
[[Category:Coding]]

Revision as of 17:43, 1 October 2011

VLC Devel

VLC media player is a 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.

Code

Start by building VLC and use Git to get the full source code. You should also know how to compile VLC.

Before sending a patch be sure to read Sending Patch. To correctly report a bug see Report bugs.