Project

General

Profile

MAUSDevs » History » Revision 43

Revision 42 (Rogers, Chris, 09 January 2012 11:32) → Revision 43/133 (Rogers, Chris, 09 January 2012 11:34)

h1. MAUS Developer Documentation 

 h2. MAUS Documentation 

 * MAUS Overview documentation 
 ** [[System architecture|Overview of MAUS structure]] 
 ** [[Release schedule]] 
 ** [[Data Structure]] 
 * Code documentation - doxygen documentation for each class, function, method etc 
 ** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html 
 ** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html 

 h2. Development workflow  

 * [[CodingStandards|Coding Standards]] - minimum requirements for how code should be written 
 ** [[Coding style]] 
 ** [[Unit tests]] 
 ** [[Application tests]] 
 ** [[UserDocumenation|User documentation]] 
 ** [[Code review]] 
 * [[bzr_usage|Contributing to MAUS]] - how to set up bzr and add code to the MAUS repository 
 ** "Development branches of MAUS":https://code.launchpad.net/maus 

 h2. Procedures 

 
 * Releases etc 
 ** [[Release procedure]] 
 * ** [[Deployment]] 
 * [[Geometry release procedure]] 

 * Other stuff: 
 ** [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] 
 *** [[MAUSHistogramReducers|Reducers and histograms]] 
 *** [[MAUSCeleryConfiguration|Celery Configuration]] 
 *** [[MAUSDocumentCacheConfiguration|Document Cache Configuration]] 
 *** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] 
 ** [[Publications policy]] 
 ** [[Jenkins]] 
 ** [[Additional build flags]] 
 ** attachment:MAUS_Work_Specification_Template.odt