Skip to content

doc: update install command #47

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

Merged
merged 1 commit into from
Jun 15, 2017
Merged

doc: update install command #47

Show file tree
Hide file tree
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
10 changes: 7 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
Welcome to ITKPythonPackage's documentation!
============================================

This project provides a ``setup.py`` script that build ITK Python wheels.
This project provides a ``setup.py`` script to build ITK Python wheels.

ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.

The Python packages are built daily. To install the ITK Python package::

$ python -m pip install --upgrade pip
$ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest
$ python -m pip install itk

For more information on ITK's Python wrapping, see an introduction in the ITK Software Guide. There are also many downloadable examples documented in Sphinx.
For more information on ITK's Python wrapping, see `an introduction in the ITK
Software Guide
<https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch3.html#x32-420003.7>`_.
There are also many `downloadable examples documented in Sphinx
<https://itk.org/ITKExamples/search.html?q=Python>`_.

* Free software: Apache Software license
* Documentation: http://itkpythonpackage.readthedocs.org
Expand Down
16 changes: 8 additions & 8 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
.. ITKPythonPackage documentation master file, created by
sphinx-quickstart on Mon May 29 14:09:52 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to ITKPythonPackage's documentation!
============================================

This project provides a ``setup.py`` script that build ITK Python wheels.
This project provides a ``setup.py`` script to build ITK Python wheels.

ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.

The Python packages are built daily. To install the ITK Python package::

$ python -m pip install --upgrade pip
$ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest
$ python -m pip install itk

For more information on ITK's Python wrapping, see `an introduction in the ITK
Software Guide
<https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch3.html#x32-420003.7>`_.
There are also many `downloadable examples documented in Sphinx
<https://itk.org/ITKExamples/search.html?q=Python>`_.

For more information on ITK's Python wrapping, see an introduction in the ITK Software Guide. There are also many downloadable examples documented in Sphinx.

.. toctree::
:maxdepth: 2
Expand Down