Skip to content

Commit

Permalink
Add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
@JeffFessler
JeffFessler committed May 22, 2024
1 parent 19f0d0c commit ca9a9a4
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ https://github.com/JeffFessler/MIRTio.jl
[![license][license-img]][license-url]
[![docs-stable][docs-stable-img]][docs-stable-url]
[![docs-dev][docs-dev-img]][docs-dev-url]
[![Aqua QA][aqua-img]][aqua-url]
[![code-style][code-blue-img]][code-blue-url]
[![deps](https://juliahub.com/docs/MIRTio/deps.svg)](https://juliahub.com/ui/Packages/MIRTio)
[![version](https://juliahub.com/docs/MIRTio/version.svg)](https://juliahub.com/ui/Packages/MIRTio)
[![pkgeval](https://juliahub.com/docs/MIRTio/pkgeval.svg)](https://juliahub.com/ui/Packages/MIRTio)


File I/O routines for
[MIRT (Michigan Image Reconstruction Toolbox) in Julia](https://github.com/JeffFessler/MIRT.jl)
Expand All @@ -16,7 +22,8 @@ because complete tests of these functions
require large files
that are not part of the repo.

The primary functions exported are for reading GE MRI kspace data:
The primary functions exported are
for reading GE MRI k-space data:
* `loadpfile`
* `read_rdb_hdr`

Expand All @@ -25,6 +32,9 @@ which are common in legacy medical imaging formats,
are in `src/ge-mri/header.jl`,
such as `header_read` and `header_write`.

For reading MRI k-space data from GE's Raw Data Server, use
* `loadrds`

Also included are utilities for reading the HDF5 formatted
raw MRI kspace data
in the
Expand All @@ -36,16 +46,19 @@ This software was developed at the
by
[Jeff Fessler](http://web.eecs.umich.edu/~fessler)
and his
[group](http://web.eecs.umich.edu/~fessler/group).
[group](http://web.eecs.umich.edu/~fessler/group)
and collaborators.

Currently tested with Julia 1.10,
but may work with earlier versions too.

<!-- URLs -->
[action-img]: https://github.com/JeffFessler/MIRTio.jl/workflows/Unit%20test/badge.svg
[action-img]: https://github.com/JeffFessler/MIRTio.jl/workflows/CI/badge.svg
[action-url]: https://github.com/JeffFessler/MIRTio.jl/actions
[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/M/MIRTio.svg
[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/M/MIRTio.html
[aqua-img]: https://img.shields.io/badge/Aqua.jl-%F0%9F%8C%A2-aqua.svg
[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
[code-blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
[code-blue-url]: https://github.com/invenia/BlueStyle
[codecov-img]: https://codecov.io/github/JeffFessler/MIRTio.jl/coverage.svg?branch=main
[codecov-url]: https://codecov.io/github/JeffFessler/MIRTio.jl?branch=main
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
Expand All @@ -54,8 +67,5 @@ but may work with earlier versions too.
[docs-dev-url]: https://JeffFessler.github.io/MIRTio.jl/dev
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat
[license-url]: LICENSE
<!--
[![coveralls][coveralls-img]][coveralls-url]
[coveralls-img]: https://coveralls.io/repos/JeffFessler/MIRTio.jl/badge.svg?branch=main
[coveralls-url]: https://coveralls.io/github/JeffFessler/MIRTio.jl?branch=main
-->
[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/M/MIRTio.svg
[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/M/MIRTio.html

2 comments on commit ca9a9a4

@JeffFessler
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator() register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/107369

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.4.0 -m "<description of version>" ca9a9a48fc7e7d781273dee61a969ba8ab7a536f
git push origin v0.4.0

Please sign in to comment.