diff --git a/README b/README index dd3a889fbe..e670bfcb70 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ DCMTK -This DICOM ToolKit (DCMTK) package consists of source code, documentation -and installation instructions for a set of software libraries and -applications implementing part of the DICOM/MEDICOM Standard. +This DICOM toolkit (DCMTK) package consists of source code, documentation and +installation instructions for a set of software libraries and applications +implementing part of the DICOM/MEDICOM Standard. DCMTK contains the following sub-packages, each in its own sub-directory: @@ -37,10 +37,10 @@ application source code (apps), library source code (libsrc), library include files (include), configuration data (etc), documentation (docs), sample and support data (data) as well as test programs (tests). -To build and install the DCMTK package see the INSTALL file. For copyright -information see the COPYRIGHT file. For information about the history of -this software see the HISTORY file. For answers to frequently asked -questions please consult the FAQ: +To build and install the DCMTK package, see the INSTALL file. For copyright +information, see the COPYRIGHT file. For information about the history of +this software, see the HISTORY file. For answers to frequently asked +questions, please consult the FAQ: https://forum.dcmtk.org/faq/ @@ -54,8 +54,10 @@ hearing about them. Please send electronic mail to: bugs/at/dcmtk/dot/org -Please try to describe the problem in detail and if possible give a -suggested fix. For general questions on how to compile, install or use -the toolkit we recommend the public discussion forum at: +Please try to describe the problem in detail and if possible give a suggested +fix. For more details on how to contribute, see the CONTRIBUTING.md file. + +For general questions on how to compile, install or use the toolkit, we +recommend the public discussion forum at: https://forum.dcmtk.org/ diff --git a/README.md b/README.md index 11c350d281..c89ee03b78 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DCMTK -This DICOM ToolKit (DCMTK) package consists of source code, documentation and installation instructions for a set of software libraries and applications implementing part of the DICOM/MEDICOM Standard. +This DICOM toolkit (DCMTK) package consists of source code, documentation and installation instructions for a set of software libraries and applications implementing part of the DICOM/MEDICOM Standard. DCMTK contains the following sub-packages, each in its own sub-directory: @@ -31,10 +31,10 @@ DCMTK contains the following sub-packages, each in its own sub-directory: Each sub-directory (except _config_) contains further sub-directories for application source code (_apps_), library source code (_libsrc_), library include files (_include_), configuration data (_etc_), documentation (_docs_), sample and support data (_data_) as well as test programs (_tests_). -To build and install the DCMTK package see the [INSTALL](INSTALL) file. For copyright information see the [COPYRIGHT](COPYRIGHT) file. For information about the history of this software see the [HISTORY](HISTORY) file. For answers to frequently asked questions please consult the [FAQ](https://forum.dcmtk.org/faq/). +To build and install the DCMTK package, see the [INSTALL](INSTALL) file. For copyright information, see the [COPYRIGHT](COPYRIGHT) file. For information about the history of this software, see the [HISTORY](HISTORY) file. For answers to frequently asked questions, please consult the [FAQ](https://forum.dcmtk.org/faq/). In addition to the API documentation, which is also available [online](https://support.dcmtk.org/docs/), there is a [Wiki](https://support.dcmtk.org/wiki/) system where further information (e.g. HOWTOs) can be found. -If you find bugs or other problems with this software, we would appreciate hearing about them. Please send electronic mail to: bugs/at/dcmtk/dot/org +If you find bugs or other problems with this software, we would appreciate hearing about them. Please send electronic mail to bugs/at/dcmtk/dot/org. Please try to describe the problem in detail and if possible give a suggested fix. For more details on how to contribute, see the [CONTRIBUTING.md](CONTRIBUTING.md) file. -Please try to describe the problem in detail and if possible give a suggested fix. For general questions on how to compile, install or use the toolkit we recommend the [public discussion forum](https://forum.dcmtk.org/). +For general questions on how to compile, install or use the toolkit, we recommend the [public discussion forum](https://forum.dcmtk.org/). diff --git a/doxygen/htmldocs.dox b/doxygen/htmldocs.dox index 049a56b4d5..9cda9d110c 100644 --- a/doxygen/htmldocs.dox +++ b/doxygen/htmldocs.dox @@ -2,7 +2,7 @@ \mainpage -This DICOM ToolKit (DCMTK) package consists of source code, documentation and +This DICOM toolkit (DCMTK) package consists of source code, documentation and installation instructions for a set of software libraries and applications implementing part of the DICOM/MEDICOM Standard. @@ -46,22 +46,22 @@ application source code (apps), library source code (libsrc), library include files (include), configuration data (etc), documentation (docs), sample and support data (data) as well as test programs (tests). -To build and install the DCMTK package see the \ref file_install "INSTALL" -file. For copyright information see the \ref file_copyright "COPYRIGHT" file. -For information about the history of this software see the +To build and install the DCMTK package, see the \ref file_install "INSTALL" +file. For copyright information, see the \ref file_copyright "COPYRIGHT" file. +For information about the history of this software, see the \ref file_history "HISTORY" file. -For answers to frequently asked questions please consult the +For answers to frequently asked questions, please consult the FAQ. There is also a Wiki system where additional information can be found. -If you find bugs or other problems with this software we would appreciate +If you find bugs or other problems with this software, we would appreciate hearing about them. Please send electronic mail to \b bugs/at/dcmtk/dot/org. Please try to describe the problem in detail and if possible give a suggested -fix. +fix. For more details on how to contribute, see the "CONTRIBUTING.md" file. -For general questions on how to compile, install or use the toolkit we +For general questions on how to compile, install or use the toolkit, we recommend the public discussion forum. */