Skip to content

DOC: Update build instructions for example .zip files #285

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
May 21, 2021
Merged

DOC: Update build instructions for example .zip files #285

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
2 changes: 1 addition & 1 deletion Documentation/Build/DownloadExampleHighlighted.png.sha512
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
a0cd374d2112ec740f37937336ceb1d568b093f9bb90e047cb3bdf83c8503b4be2572fa96dd16b78a45fb453e09ff3bff279b3a4f28fba809eef53677658d16b
fcb9e8102e8a99dc0a2d8784c4ba02a16f2f19a0aebcdc5467cc9d169ccbea41c8a28df7d30bfea3af9a4a45bfd16730551fe86953a014762edfbc4976309167
14 changes: 7 additions & 7 deletions Documentation/Build/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,32 @@ Next, install the *itk* package::
<https://itk.org/ITKExamples/src/Filtering/BinaryMathematicalMorphology/DilateABinaryImage/Documentation.html>`_
by clicking the *Download* button.

Download the *example.tar.gz* or *example.zip* file from the link on the top
Download the *<ExampleName>.zip* file from the link on the top
of an example's webpage. Unpack the example. For example,

::

tar xvzf example.tar.gz
unzip ExampleName.zip

Finally, run the example::

python examples/Code.py
python ExampleName/Code.py


.. _build-individual-examples:

Build individual examples
-------------------------

Download the *example.tar.gz* or *example.zip* file from the link on the top
Download the *<ExampleName>.zip* file from the link on the top
of the example's webpage. Unpack the example::

tar xvzf example.tar.gz
unzip ExampleName.zip

Set convenience variables::

ITK_SOURCE=example
ITK_BUILD=example/build
ITK_SOURCE=ExampleName
ITK_BUILD=ExampleName/build

Move to the build directory::

Expand Down