From a39aa0088d9e5b68e23594a7ccdc8c7101a0b520 Mon Sep 17 00:00:00 2001 From: Erik Ziegler Date: Fri, 17 May 2019 16:16:22 +0200 Subject: [PATCH] docs(README.md): Updated README to fix URLs --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a77995015..0c450e6f3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@

ohif-viewer

-

ohif-viewer is a zero-footprint medical image viewer. It is a configurable and exstensible progressive web application with out of the box support for PACS like orthanc, dcm4che, and Google's Healthcare API.

+

ohif-viewer is a zero-footprint medical image viewer provided by the [Open Health Imaging Foundation (OHIF)](http://ohif.org/). It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support DICOMweb.

- Read The Docs | - Edit the docs + Read The Docs | + Edit the docs
@@ -39,16 +39,15 @@ workflow customization and advanced functionality at common integration points. If you're interested in using the OHIF Viewer, but you're not sure it supports your use case -[check out our docs](https://deploy-preview-398--ohif.netlify.com/). Still not +[check out our docs](https://docs.ohif.org/). Still not sure, or you would like to propose new features? Don't hesitate to -[create an issue](https://github.com/OHIF/Viewers/issues) or open a pull request -^\_^ +[create an issue](https://github.com/OHIF/Viewers/issues) or open a pull request. ## Getting Started This readme is specific to testing and developing locally. If you're more interested in production deployment strategies, -[you can check out our documentation on publishing](https://deploy-preview-398--ohif.netlify.com/). +[you can check out our documentation on publishing](https://docs.ohif.org/). Want to play around before you dig in? [Check out our LIVE Demo](https://viewer.ohif.org/) @@ -86,7 +85,7 @@ yarn start For more advanced local development scenarios, like using your own locally hosted PACS and test data, -[check out our Essential: Getting Started](https://deploy-preview-398--ohif.netlify.com/essentials/getting-started.html) +[check out our Essential: Getting Started](https://docs.ohif.org/essentials/getting-started.html) guide. ### Contributing @@ -94,7 +93,7 @@ guide. > Large portions of the Viewer's functionality are maintained in other > repositories. To get a better understanding of the Viewer's architecture and > "where things live", read -> [our docs on the Viewer's architecture](https://deploy-preview-398--ohif.netlify.com/advanced/architecture.html#diagram) +> [our docs on the Viewer's architecture](https://docs.ohif.org/advanced/architecture.html#diagram) It is notoriously difficult to setup multiple dependent repositories for end-to-end testing and development. That's why we recommend writing and running @@ -108,7 +107,7 @@ well-tested business logic. 4. To commit changes, run `yarn run cm` When creating tests, place the test file "next to" the file you're testing. -[For example](https://github.com/OHIF/Viewers/blob/react/src/index.test.js): +[For example](https://github.com/OHIF/Viewers/blob/master/src/utils/index.test.js): ```js // File @@ -152,6 +151,22 @@ or file an issue on GitHub. MIT © [OHIF](https://github.com/OHIF) +## Acknowledgments + +To acknowledge the OHIF Viewer in an academic publication, please cite + +> *LesionTracker: Extensible Open-Source Zero-Footprint Web Viewer for Cancer Imaging Research and Clinical Trials* +> +> Trinity Urban, Erik Ziegler, Rob Lewis, Chris Hafey, Cheryl Sadow, Annick D. Van den Abbeele and Gordon J. Harris +> +> _Cancer Research_, November 1 2017 (77) (21) e119-e122 +> DOI: [10.1158/0008-5472.CAN-17-0334](https://www.doi.org/10.1158/0008-5472.CAN-17-0334) + + +**Note:** If you use or find this repository helpful, please take the time to star this repository on Github. This is an easy way for us to assess adoption and it can help us obtain future funding for the project. + +This work is supported primarily by the National Institutes of Health, National Cancer Institute, Informatics Technology for Cancer Research (ITCR) program, under a [grant to Dr. Gordon Harris at Massachusetts General Hospital (U24 CA199460)](https://projectreporter.nih.gov/project_info_description.cfm?aid=8971104). + @@ -178,8 +193,8 @@ Links: [react-url]: https://reactjs.org/ [pwa-url]: https://developers.google.com/web/progressive-web-apps/ [ohif-viewer-url]: https://www.npmjs.com/package/ohif-viewer -[configuration-url]: https://deploy-preview-398--ohif.netlify.com/essentials/configuration.html -[extensions-url]: https://deploy-preview-398--ohif.netlify.com/advanced/extensions.html +[configuration-url]: https://docs.ohif.org/essentials/configuration.html +[extensions-url]: https://docs.ohif.org/advanced/extensions.html [react-viewer]: https://github.com/OHIF/Viewers/tree/react