Difference between revisions of "Getting Started At Coding"
(→Code) |
|||
| Line 8: | Line 8: | ||
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. | 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. | ||
| − | == 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]]. | ||
| − | Before sending a patch be sure to read [[Sending Patch]]. To correctly report a bug see [[Report bugs]]. | + | == Understand the Code == |
| + | |||
| + | 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 11:42, 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
Before sending a patch be sure to read Sending Patch.
To correctly report a bug see Report bugs.
