Skip to content

Commit

Permalink
Refresh README, add mailing list link to README and Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JackEAllen committed Jan 12, 2024
1 parent 73c613a commit f760196
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
<div align="center">
<a href="https://mantidproject.github.io/mantidimaging/">
<img src="images/mantid_imaging_64px.ico" alt="Logo" width="80" height="80">
</a>

<h1 align="center">MantidImaging</h1>

<p align="center" style="font-size: 18px">
<strong>A graphical toolkit for 3D reconstruction of neutron tomography data</strong>
<br />
<br />
<a href="https://mantidproject.github.io/mantidimaging/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://anaconda.org/mantid/mantidimaging"><b>Anaconda Package</b></a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues"><b>Code Repository</b></a>
·
<a href="https://www.jiscmail.ac.uk/cgi-bin/wa-jisc.exe?SUBED1=MANTID-IMAGING-ANNOUNCE&A=1"><b>Release Mailing List</b></a>
</p>
</div>

# MantidImaging

Mantid Imaging is a graphical toolkit for performing 3D reconstruction of neutron tomography data. It provides an easy-to-use graphical interface to a wide range of pre/post-processing operations, tilt correction and reconstruction algorithms, accommodating for tomography users with varying data complexity and image analysis background knowledge. It utilises a flexible plugin system that allows easy integration of external software, and has allowed us to re-use software widely known in the neutron tomography community.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4728059.svg)](https://doi.org/10.5281/zenodo.4728059)
[![Coverage Status](https://coveralls.io/repos/github/mantidproject/mantidimaging/badge.svg?branch=main)](https://coveralls.io/github/mantidproject/mantidimaging?branch=main)

## Links

- Documentation: https://mantidproject.github.io/mantidimaging/
- Anaconda package: https://anaconda.org/mantid/mantidimaging
- Code repository: https://github.com/mantidproject/mantidimaging
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ Please cite as:
Tasev, Dimitar; Akello-Egwel, Dolica; Allen, Jack; Baust, Rachel; Gigg, Martyn; Jones, Samuel; Nixon, Daniel; Stock, Samuel; Taylor, Will; Tygier, Sam. (2023). Mantid Imaging (2.5.0), Zenodo https://doi.org/10.5281/zenodo.4728059

(See `Zenodo <https://doi.org/10.5281/zenodo.4728059>`_ for citing specific versions).

Sign up to our mailing list `HERE <https://www.jiscmail.ac.uk/cgi-bin/wa-jisc.exe?SUBED1=MANTID-IMAGING-ANNOUNCE&A=1>`_ to receive updates on the project
5 changes: 5 additions & 0 deletions docs/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,8 @@ Issues can be reported on the `Github project page <https://github.com/mantidpro

The developers can be contacted at
[email protected]

Release Updates
===============

Sign up to our mailing list `HERE <https://www.jiscmail.ac.uk/cgi-bin/wa-jisc.exe?SUBED1=MANTID-IMAGING-ANNOUNCE&A=1>`_ to receive updates on the project

0 comments on commit f760196

Please sign in to comment.