Difference between revisions of "Getting Started At Coding"
Line 1: | Line 1: | ||
+ | == VLC Devel == | ||
+ | |||
VLC media player is a very fast changing and ever evolving project. | VLC media player is a very fast changing and ever evolving project. | ||
Line 4: | Line 6: | ||
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 == | ||
New code can be submitted to the vlc-devel mailing-list and will be evaluated for inclusion to the SVN tree. You should put [PATCH] in your subject header. All patches need to be against the HEAD SVN tree. You can create them by running svn diff in the VLC source directory. | New code can be submitted to the vlc-devel mailing-list and will be evaluated for inclusion to the SVN tree. You should put [PATCH] in your subject header. All patches need to be against the HEAD SVN tree. You can create them by running svn diff in the VLC source directory. | ||
+ | |||
+ | Start by building VLC and use [[Subversion]] to get the full source code. | ||
Before you start be sure to read the HACKING file in the main VLC source directory. | Before you start be sure to read the HACKING file in the main VLC source directory. |
Revision as of 09:44, 21 December 2006
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 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
New code can be submitted to the vlc-devel mailing-list and will be evaluated for inclusion to the SVN tree. You should put [PATCH] in your subject header. All patches need to be against the HEAD SVN tree. You can create them by running svn diff in the VLC source directory.
Start by building VLC and use Subversion to get the full source code.
Before you start be sure to read the HACKING file in the main VLC source directory.