Project

General

Profile

MAUSDevs » History » Version 24

Rogers, Chris, 08 August 2011 08:44

1 1 Rogers, Chris
h1. MAUS Developer Documentation
2
3 24 Rogers, Chris
* [[System architecture|Overview of MAUS structure]]
4 10 Rogers, Chris
* Code documentation - doxygen documentation for each class, function, method etc
5 3 Rogers, Chris
** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html
6 4 Rogers, Chris
** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html
7 10 Rogers, Chris
* [[CodingStandards|Coding Standards]] - minimum requirements for how code should be written
8 9 Rogers, Chris
** [[Coding style]]
9
** [[Unit tests]]
10
** [[Application tests]]
11 11 Rogers, Chris
** [[Code review]]
12 10 Rogers, Chris
* [[bzr_usage|Contributing to MAUS]] - how to set up bzr and add code to the MAUS repository
13 17 Rogers, Chris
** "Development branches of MAUS":https://code.launchpad.net/maus
14 12 Rogers, Chris
15 14 Rogers, Chris
* Other stuff:
16
** [[Publications policy]]
17
** [[Release procedure]]
18 16 Rogers, Chris
** [[Jenkins]]
19 19 Rogers, Chris
** [[Additional build flags]]
20 13 Rogers, Chris
21 2 Rogers, Chris
* [[Design|Design and philosophy]]
22
* [[Examples|Examples of using MAUS]]