1,079
edits
(Update ref to Portability Guide to Coding Conventions) |
(→Getting started: Mention git explicitly, and link to the git tips page) |
||
Line 2: | Line 2: | ||
== Getting started == | == Getting started == | ||
* The first thing you need to be able to do is [[Git#Retrieving_the_code|get the ScummVM code]]. | * The first thing you need to be able to do is [[Git#Retrieving_the_code|get the ScummVM code]] from our [[Git]] repository. | ||
* Then you should [[Compiling ScummVM|compile ScummVM]]. | * Then you should [[Compiling ScummVM|compile ScummVM]]. | ||
Line 10: | Line 10: | ||
* Before you write/submit code, '''you must read about our''' [[Code Formatting Conventions]]. Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them. | * Before you write/submit code, '''you must read about our''' [[Code Formatting Conventions]]. Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them. | ||
* Also, you should read and respect the general [[Coding Conventions]]. | * Also, you should read and respect the general [[Coding Conventions]]. | ||
* If you have write access to our repository, you are expected to have read and to comply with our [[Commit Guidelines]]. | * If you have write access to our repository, you are expected to have read and to comply with our [[Commit Guidelines]]. Also, read up on the [[Git tips]]. | ||
* If you do not have write access, you should use our [http://sourceforge.net/tracker/?group_id=37116&atid=418822 patch tracker] to submit your contributions. | * If you do not have write access, you should use our [http://sourceforge.net/tracker/?group_id=37116&atid=418822 patch tracker] to submit your contributions. | ||
* Our [http://doxygen.scummvm.org/ Doxygen source code documentation] may help you to get the big picture about ScummVM. | * Our [http://doxygen.scummvm.org/ Doxygen source code documentation] may help you to get the big picture about ScummVM. |
edits