diff --git a/Documentation/Doxygen/1-Overview/Overview.dox b/Documentation/Doxygen/1-Overview/Overview.dox index dffa52def6..15ed4cd549 100644 --- a/Documentation/Doxygen/1-Overview/Overview.dox +++ b/Documentation/Doxygen/1-Overview/Overview.dox @@ -1,32 +1,30 @@ /** \page Overview An Overview \ingroup index -The Medical Imaging Interaction Toolkit (MITK) is a powerful application and can also be used as either a framework or a toolkiit for Software development. The following options are the most common usage scenarios. - - - - +The Medical Imaging Interaction Toolkit (MITK) is a versatile and flexible open-source +project. It can be used as a C++ toolkit or application framework for software development. +The following sections describe the most common usage scenarios. I want to use MITK as an application You will use the MITK Workbench as an end user and will find user manuals in \ref UserManualPortal and \ref PluginListPage. I want to develop my own software framework, and use some of MITK's data structures and algorithms You will use MITK as a toolkit and probably benefit most from the \ref BuildInstructionsPage and MITK API Documentation. I want to use the MITK and BlueBerry software framework to develop my own software Here you have again two options. I want use the MITK Workbench and extend its capabilities You are using MITK as software framework and writing your own modules and plugins for MITK. You want to read the \ref BuildInstructionsPage and further on \ref Development. Also you might want to take a look at our \ref CMAKE_FAQ. I want to create my own application based on MITK This is probably the most common way to use MITK. You are using MITK as software framework and building your own project and application using MITK. You want to read \ref HowToNewProject and the general information in \ref Development. Also you might want to take a look at our \ref CMAKE_FAQ. */ diff --git a/Documentation/Doxygen/2-UserManual/UserManualPortal.dox b/Documentation/Doxygen/2-UserManual/UserManualPortal.dox index a34e68278a..71daca8bcf 100644 --- a/Documentation/Doxygen/2-UserManual/UserManualPortal.dox +++ b/Documentation/Doxygen/2-UserManual/UserManualPortal.dox @@ -1,21 +1,21 @@ /** \usersguidemainpage{UserManualPortal} User Manual To get an introduction to the usage of any MITK based application please read \ref MITKUserManualPage. It will give you an overview of most of the common questions, such as how to load or save data or navigate within it. This is a good starting point for first questions. Depending on what kind of work you intend do perform with MITK, certain applications are better suited to your needs than others. MITK offers a number of these Applications, each of which features a set of Plugins, which can solve certain tasks. To Learn more about MITK applications, please visit the \ref ApplicationsPage. For more specific information on how a plugin operates you can find the plugin documentation in \ref PluginListPage. The Plugin documentation usually explains the functionality in depth and should solve most problems you might encounter with the plugin. Depending on the application you are using you might have only some or all of the listed plugins available. Lastly, if your question is not answered here, please use our Mailinglist to let us know about your problem. Alternatively, you can contact us directly. -

UserManualPortalTopics List of topics

+

List of topics

*/ diff --git a/README.md b/README.md index 5e16e7e39f..4986268598 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,94 @@ ![MITK Logo][logo] The [Medical Imaging Interaction Toolkit][mitk] (MITK) is a free open-source software system for development of interactive medical image processing software. MITK combines the [Insight Toolkit][itk] (ITK) and the [Visualization Toolkit][vtk] (VTK) with an application framework. +The links below provide high-level and reference documentation targeting different +usage scenarios: + + - Get a [high-level overview][mitk-overview] about MITK with pointers to further + documentation + - End-users looking for help with MITK applications should read the + [MITK User Manual][mitk-usermanual] + - Developers contributing to or using MITK, please see the [MITK Developer Manual][mitk-devmanual] + as well as the [MITK API Reference][mitk-apiref] + See the [MITK homepage][mitk] for details. Supported Platforms ----------------------------- MITK is a cross-platform C++ toolkit and officially supports: - Windows - MacOS X - Linux For details, please read the [Supported Platforms][platforms] page. License ----------- Copyright (c) [German Cancer Research Center][dkfz]. MITK is available as free open-source software under a [BSD-style license][license]. Download --------- The MITK source code and binaries for the *mitkWorkbench* application are released regularly according to the [MITK release cycle][release-cycle]. See the [Download][download] page for a list of releases. The official MITK source code is available in the [MITK Git repository][gitweb]. The Git clone command is git clone http://git.mitk.org/MITK.git Active development takes place in the MITK master branch and its usage is advised for advanced users only. How to Contribute -------------- Contributions of all kind are happily accepted. However, to make the contribution process as smooth as possible, please read the [How to contribute to MITK][contribute] page if you plan to contribute to MITK. Build Instructions ------------------------ MITK uses [CMake][cmake] to configure a build tree. The following is a crash course about cloning, configuring, and building MITK on a Linux/Unix system: git clone http://git.mitk.org/MITK.git mkdir MITK-build cd MITK-build cmake ../MITK make -j4 Read the comprehensive [Build Instructions][build] page for details. Useful Links ------------------ - [Homepage][mitk] - [Download][download] - [Mailing List][mailinglist] - [Bug Tracker][bugs] [logo]: https://github.com/MITK/MITK/raw/master/mitk.png [mitk]: http://mitk.org [itk]: http://www.itk.org [vtk]: http://www.vtk.org +[mitk-overview]: http://docs.mitk.org/nightly-qt4/Overview.html +[mitk-usermanual]: http://docs.mitk.org/nightly-qt4/UserManualPortal.html +[mitk-devmanual]: http://docs.mitk.org/nightly-qt4/DeveloperManualPortal.html +[mitk-apiref]: http://docs.mitk.org/nightly-qt4/usergroup0.html [platforms]: http://docs.mitk.org/nightly-qt4/SupportedPlatformsPage.html [dkfz]: http://www.dkfz.de [license]: http://mitk.org/git/?p=MITK.git;a=blob_plain;f=LICENSE.txt [release-cycle]: http://mitk.org/MitkReleaseCycle [download]: http://mitk.org/Download [gitweb]: http://mitk.org/git/?p=MITK.git [contribute]: http://mitk.org/How_to_contribute [cmake]: http://www.cmake.org [build]: http://docs.mitk.org/nightly-qt4/BuildInstructionsPage.html [mailinglist]: http://mitk.org/Mailinglist [bugs]: http://bugs.mitk.org/