From 161aeaf68888475ac7e319d35e25d43364b74831 Mon Sep 17 00:00:00 2001 From: Rob Young Date: Mon, 18 May 2020 16:21:24 +0100 Subject: [PATCH 1/2] Improve README docs - Add badges for documentation in docs.rs and entry in crates.io. - Add crates.io and docs.rs badges to sub-crate READMEs. - Add some links to extra information. --- README.md | 18 +++++++++++++----- core/README.md | 3 +++ dcmdump/README.md | 9 +++++++++ dictionary-builder/README.md | 3 +++ dictionary-std/README.md | 5 ++++- encoding/README.md | 6 ++++++ object/README.md | 8 +++++++- parser/README.md | 3 +++ 8 files changed, 48 insertions(+), 7 deletions(-) create mode 100644 dcmdump/README.md create mode 100644 encoding/README.md diff --git a/README.md b/README.md index fb47420e9..614f59c3b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # DICOM-rs -[![Build Status](https://travis-ci.org/Enet4/dicom-rs.svg?branch=master)](https://travis-ci.org/Enet4/dicom-rs) ![Minimum Rust Version Stable](https://img.shields.io/badge/Minimum%20Rust%20Version-stable-green.svg) [![dependency status](https://deps.rs/repo/github/Enet4/dicom-rs/status.svg)](https://deps.rs/repo/github/Enet4/dicom-rs) [![Gitter](https://badges.gitter.im/dicom-rs/community.svg)](https://gitter.im/dicom-rs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![Build Status](https://travis-ci.org/Enet4/dicom-rs.svg?branch=master)](https://travis-ci.org/Enet4/dicom-rs) +![Minimum Rust Version Stable](https://img.shields.io/badge/Minimum%20Rust%20Version-stable-green.svg) +[![dependency status](https://deps.rs/repo/github/Enet4/dicom-rs/status.svg)](https://deps.rs/repo/github/Enet4/dicom-rs) +[![Gitter](https://badges.gitter.im/dicom-rs/community.svg)](https://gitter.im/dicom-rs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![CratesIO](https://img.shields.io/crates/v/dicom.svg)](https://crates.io/crates/dicom) +[![Documentation](https://docs.rs/dicom/badge.svg)](https://docs.rs/dicom) -An efficient and practical library for DICOM compliant systems. +An efficient and practical library for [DICOM](https://en.wikipedia.org/wiki/DICOM) compliant systems. This collection provides a pure Rust implementation of the DICOM standard, allowing users to read and write DICOM objects over files and other sources, while @@ -22,9 +27,11 @@ remaining intrinsically fast and safe to use. ## Using as a library -[`dicom-object`](object) is currently the most usable crate for reading DICOM objects from a file or a similar source. As an alternative, the parent crate [`dicom`](parent) can be added instead, which aggregates the key components of the full library, including `dicom-object`. +[`dicom-object`](object) is currently the most usable crate for reading DICOM objects from a file or a similar source. +As an alternative, the parent crate [`dicom`](parent) can be added instead, which aggregates the key components of the +full library, including `dicom-object`. -An example of use follows. For more, please visit the respective [documentation](https://docs.rs/dicom-object). +An example of use follows. For more details, please visit the [`dicom-object` documentation](https://docs.rs/dicom-object). ```rust use dicom_object::open_file; @@ -47,7 +54,8 @@ cargo build --release This project is a work in progress, but actively developed. -Your feedback during the development of these solutions is welcome. Please see the [wiki](https://github.com/Enet4/dicom-rs/wiki) for additional guidelines related to the project's roadmap. +Your feedback during the development of these solutions is welcome. Please see the [wiki](https://github.com/Enet4/dicom-rs/wiki) +for additional guidelines related to the project's roadmap. ## License diff --git a/core/README.md b/core/README.md index 8daa94f16..4ea848196 100644 --- a/core/README.md +++ b/core/README.md @@ -1,3 +1,6 @@ # DICOM-rs core library +[![CratesIO](https://img.shields.io/crates/v/dicom-core.svg)](https://crates.io/crates/dicom-core) +[![Documentation](https://docs.rs/dicom-core/badge.svg)](https://docs.rs/dicom-core) + This sub-project implements the essential data structures and mechanisms for dealing with DICOM information and communication formats. This crate is used by other crates in DICOM-rs. diff --git a/dcmdump/README.md b/dcmdump/README.md new file mode 100644 index 000000000..5bf2d2125 --- /dev/null +++ b/dcmdump/README.md @@ -0,0 +1,9 @@ +# dcmdump + +A command line utility for inspecting DICOM files. + +## Usage + +```shell +> dcmdump [FILE] +``` diff --git a/dictionary-builder/README.md b/dictionary-builder/README.md index 5b59df4b4..35b393e95 100644 --- a/dictionary-builder/README.md +++ b/dictionary-builder/README.md @@ -1,5 +1,8 @@ # DICOM Dictionary Builder +[![CratesIO](https://img.shields.io/crates/v/dicom-dictionary-builder.svg)](https://crates.io/crates/dicom-dictionary-builder) +[![Documentation](https://docs.rs/dicom-dictionary-builder/badge.svg)](https://docs.rs/dicom-dictionary-builder) + This sub-project is a tool for generating machine readable attribute dictionaries from the DICOM standard. ## Building diff --git a/dictionary-std/README.md b/dictionary-std/README.md index 625ee77cb..61f15240d 100644 --- a/dictionary-std/README.md +++ b/dictionary-std/README.md @@ -1,3 +1,6 @@ # DICOM-rs standard dictionary -This sub-project uses entries generated by the [dictionary_builder](../dictionary_builder) to provide the standard DICOM data dictionary. +[![CratesIO](https://img.shields.io/crates/v/dicom-dictionary-std.svg)](https://crates.io/crates/dicom-dictionary-std) +[![Documentation](https://docs.rs/dicom-dictionary-std/badge.svg)](https://docs.rs/dicom-dictionary-std) + +This sub-project uses entries generated by the [`dictionary_builder`](../dictionary_builder) to provide the standard DICOM data dictionary. diff --git a/encoding/README.md b/encoding/README.md new file mode 100644 index 000000000..ff869250d --- /dev/null +++ b/encoding/README.md @@ -0,0 +1,6 @@ +# DICOM-rs encoding library + +[![CratesIO](https://img.shields.io/crates/v/dicom-encoding.svg)](https://crates.io/crates/dicom-encoding) +[![Documentation](https://docs.rs/dicom-core/badge.svg)](https://docs.rs/dicom-core) + +This sub-project provides DICOM data encoding and decoding primitives. diff --git a/object/README.md b/object/README.md index 1169120d4..39b12cab7 100644 --- a/object/README.md +++ b/object/README.md @@ -1,3 +1,9 @@ # DICOM-rs object library -This sub-project is directed at the user of the DICOM-rs ecosystem. It provides a high-level abstraction to DICOM objects, enabling objects to be retrieved from files or other common sources, and then analysed as a tree of attributes. +[![CratesIO](https://img.shields.io/crates/v/dicom-object.svg)](https://crates.io/crates/dicom-object) +[![Documentation](https://docs.rs/dicom-object/badge.svg)](https://docs.rs/dicom-object) + +This sub-project is directed at users of the DICOM-rs ecosystem. It provides a high-level +abstraction to DICOM objects, enabling objects to be retrieved from files or +['readers'](https://doc.rust-lang.org/std/io/trait.Read.html), and then analysed as a tree +of attributes. diff --git a/parser/README.md b/parser/README.md index 610dc2b34..34f45f21a 100644 --- a/parser/README.md +++ b/parser/README.md @@ -1,4 +1,7 @@ # DICOM-rs parser library +[![CratesIO](https://img.shields.io/crates/v/dicom-parser.svg)](https://crates.io/crates/dicom-parser) +[![Documentation](https://docs.rs/dicom-parser/badge.svg)](https://docs.rs/dicom-parser) + This sub-project implements the mechanisms for encoding, decoding and parsing DICOM content. From 51d790e0f910a44610ed7e6505105282b701694e Mon Sep 17 00:00:00 2001 From: Rob Young Date: Tue, 19 May 2020 08:11:46 +0100 Subject: [PATCH 2/2] Update DICOM URL Co-authored-by: Eduardo Pinho --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 614f59c3b..7a303cd01 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![Documentation](https://docs.rs/dicom/badge.svg)](https://docs.rs/dicom) -An efficient and practical library for [DICOM](https://en.wikipedia.org/wiki/DICOM) compliant systems. +An efficient and practical library for [DICOM](https://dicomstandard.org) compliant systems. This collection provides a pure Rust implementation of the DICOM standard, allowing users to read and write DICOM objects over files and other sources, while