Page MenuHomePhabricator

Move tutorial for creating your own project to doxygen and expand it
Closed, ResolvedPublic

Description

The tutorial for setting up a mitk prejct is currently found at
http://www.mitk.org/SetupAMitkBasedProject

This should be added to the doxygen documentation.

Additionally We should probably divide it into two parts:

  1. The description of the idea and concepts behind the different usage scenarios in MITK for experienced developers (see T11114 ).
  1. A program-along tutorial for inexperienced new users, who probably won't mind being told to build their source by typing "make"

Some thoughts:

Development with MITK

First steps

How do I use MITK?

Basically there are three ways to use MITK:

  • As toolkit -> short one sentence description
  • As application framework -> short one sentence description
  • As End user -> short one sentence description

For more information on the different scenarios see <bug-11114 document> .

I want to develop my own awesome app to do X, how do I start?

For a detailed how-to for setting up your own application see <how-to-application>

For a concise explanation of designing your application see <document-aimed-at-experienced-developers> to see the involved concepts and ideas.

Event Timeline

New remote branch pushed: bug-13772-move-and-expand-new-project-documentation

[b37619]: Merge branch 'bug-13772-move-and-expand-new-project-documentation'

Merged commits:

2012-12-06 12:53:57 Caspar Goch [6e74c6]
Some style changes, fixed some links


2012-12-06 12:07:47 Caspar Goch [311e6d]
Adjusted rest of the documentation to include new pages


2012-12-06 12:07:02 Caspar Goch [c74114]
Ported deployment page


2012-12-06 12:04:38 Caspar Goch [1d9405]
Ported the tutorial further and made some adjustments


2012-12-05 15:03:35 Caspar Goch [5dc146]
First version of new how to, from nothing to binary

Port complete, expansion of the documentation will probably wait for after the release.

New remote branch pushed: bug-13772-expand-newcomers-documentation

[3d329d]: Merge branch 'bug-13772-expand-newcomers-documentation'

Merged commits:

2012-12-12 17:52:50 Caspar Goch [94c486]
Added short introduction

New remote branch pushed: bug-13772-add-FAQs

[1bd721]: Merge branch 'bug-13772-add-FAQs'

Merged commits:

2013-01-08 09:47:35 Caspar Jonas Goch [e27fca]
Added cmake FAQ

Signed-off-by: Caspar Goch <c.goch@dkfz-heidelberg.de>

[40d0ab]: Merge branch 'bug-13772-add-FAQs'

Merged commits:

2013-01-09 15:52:39 Caspar Goch [e7fbad]
Fixed some typos and removed CMake links

Documentation has been ported, further improvements will be target of other bugs.