X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=inline;f=Doc%2FDoxyIntroduction.txt;fp=Doc%2FDoxyIntroduction.txt;h=8473462c68f12034e353efb6664d46c60462de89;hb=4d142119a0634c2afa748c9b443c253ec95a85d3;hp=0000000000000000000000000000000000000000;hpb=a5d92ab54014d69e1c37116eb923dc3c5dc2e21f;p=gdcm.git
diff --git a/Doc/DoxyIntroduction.txt b/Doc/DoxyIntroduction.txt
new file mode 100644
index 00000000..8473462c
--- /dev/null
+++ b/Doc/DoxyIntroduction.txt
@@ -0,0 +1,44 @@
+/**
+ * \page DoxyIntroduction Introduction
+ *
+ * Gdcm -which stands for Gnu DiCoM- is yet another C++ library
+ * dedicated to reading/parsing and writing
+ * Dicom files.
+ *
+ * \section DoxyFeatures Features
+ * - gdcm implements the
+ *
+ * dicom base standard part 5 that concentrates on image file format.
+ * Hence gdcm supports the following formats:
+ * -# ACR-NEMA version 1 and 2
+ * -# Dicom version 3.
+ * - gdcm is distributed with
+ * LPGL
+ * for the license.
+ * - gdcm targets both GNU/Un*ces and Windows/VC++ (see \ref
+ * DoxyRequirements).
+ * - gdcm comes with \ref DoxyPythonComplete it's
+ * Python wrappers.
+ * .
+ *
+ * \section DoxyLimitation Design limitations
+ * - gdcm does not implement any other part of the Dicom base standard as
+ * opposed to
+ * CTN
+ * or
+ *
+ * DCMTK. In particular gdcm is not aware of:
+ * -# the Dicom network file exchange protocol.
+ * -# the Dicom media storage formats.
+ * .
+ * .
+ *
+ *
+ * \section DoxyTODO Features to come (TODO list)
+ * - offer Dicom jpeg compressed image support,
+ * - enable Dicom header parsing of sequences and overlays,
+ * - distribute a VTK
+ * thin wrapper of gdcm (essentially a vtkGdcmImageReader).
+ * .
+ * Installing gdcm and gdcmPyton: \ref DoxyInstallation
+ */