Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Add PyPI and license badges, install docs to README #20

Merged
merged 1 commit into from
Jun 21, 2019
Merged

DOC: Add PyPI and license badges, install docs to README #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,34 @@ ITKNDReg
:target: https://dev.azure.com/InsightSoftwareConsortium/ITKModules/_build?definitionId=15
:alt: Build status

.. image:: https://img.shields.io/pypi/v/itk-ndreg.svg
:target: https://pypi.python.org/pypi/itk-ndreg
:alt: PyPI

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://github.com/InsightSoftwareConsortium/ITKNDReg/blob/master/LICENSE)
:alt: License

Overview
--------

This is Neurodata's open-source Python package that performs affine and
deformable (LDDMM) image registration.

Installation
------------

To install the Python package::

python -m pip install itk-ndreg

Or, build the module as a separate project against an ITK build tree::

git clone https://github.com/InsightSoftwareConsortium/ITKNDReg
mkdir ITKNDReg-bulid
cd ITKNDReg-build
cmake -DITK_DIR=/path/to/ITK-build ../ITKNDReg
cmake --build .

License
-------
Expand Down