PCSX2 Documentation: Difference between revisions
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
<!--"Work safe, work smart. Your future depends on it. Now arriving at Sector C Test Labs and Control Facilities"--> | <!--"Work safe, work smart. Your future depends on it. Now arriving at Sector C Test Labs and Control Facilities"--> | ||
{{Navbox | {{Navbox | ||
|name = PCSX2 | |name = PCSX2 Starting Documentation Navbox | ||
|title = [[PCSX2 Documentation | |title = [[PCSX2 Documentation|PCSX2 Starting documentation navigation panel]] | ||
|state = {{{state|collapsed}}} | |state = {{{state|collapsed}}} | ||
|bodyclass = hlist | |bodyclass = hlist | ||
| group1 = Building with Cmake | |||
| group1 = | |||
| list1 = | | list1 = | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/Compiling on Windows|Compiling on Windows]]'' | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/Compiling on Linux|Compiling on Linux]]'' | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/PCSX2 Build Scripts|PCSX2 Build Scripts]]'' | ||
*''[[PCSX2 Documentation/Chroot and 64-bit Linux|Chroot and 64-bit Linux]]'' | |||
*''[[PCSX2 Documentation/GNU Debugger Tips|GNU Debugger Tips]]'' | |||
| group2 = | | group2 = Contributing with Github | ||
| list2 = | | list2 = | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/Git Survival Guide|Git Survival Guide]]'' | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/How to Create Useful and Valid Issues|How to Create Useful and Valid Issues]]'' | ||
*''[[PCSX2 Documentation/ | *''[[PCSX2 Documentation/Commenting Etiquette|Commenting Etiquette]]'' | ||
*''[[PCSX2 Documentation/Code Formatting Guidelines|Code Formatting Guidelines]]'' | |||
*''[[PCSX2 Documentation/Contributing To-Do List|Contributing To-Do List]]'' | |||
*''[[PCSX2 Documentation/ | |||
*''[[PCSX2 Documentation/ | |||
}} | }} | ||
<includeonly>[[Category:Browse]]</includeonly> | <includeonly>[[Category:Browse]]</includeonly> | ||
Revision as of 15:16, 19 July 2015
This page is an attempt to clearly document the PCSX2 code, to make life easier for those who wish to join the project.
Contributing to PCSX2 Documentation on the wiki
To separate documentation pages from the ordinary wiki pages all new pages should be created with PCSX2 Documentation/ prefix (example PCSX2 Documentation/Git Survival Guide). All pages should be linked to this page using navigation infobox (see below) or at least linked to a page that is in turn linked to this page. This will help in keeping a robust and easy to use structure. Similar pages may also be included in a number of categories (especially if there are a number of such pages).
NOTE TO DEVELOPERS: Please feel free to rearrange the articles in a way that makes more sense, or matches the structure of the PCSX2 code.
The contents of this page
This page should contain links to starting documentation like building PCSX2 from source, contributing and such.
| ||||||||
| |||||||||||