Skip to content

Commit 1cd2333

Browse files
committed
STYLE: Transition README files to Markdown
Transition `README` files to Markdown. Take advantage of the Markdown syntax to highlight appropriately relevant text. Use an 80-character line length limit. Cross-reference the `LICENSE` file in the license section.
1 parent bede015 commit 1cd2333

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Insight Journal Template
2+
========================
3+
4+
This repository contains a template for submitting Technical Reports to the
5+
Insight Journal:
6+
7+
http://www.insight-journal.org
8+
9+
10+
Overleaf Link: https://www.overleaf.com/latex/templates/insight-journal/grjrhxkzzsvf
11+
12+
13+
License
14+
-------
15+
16+
All source code in this repository is distributed under the Apache 2.0
17+
License. Please see the LICENSE file for details.
18+
19+
All documents and works of art in this repository are distributed under the
20+
Creative Commons by Attribution License 3.0.

Source/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Insight Journal Submission Code
2+
-------------------------------
3+
4+
This directory contains a template for a submission to the Insight Journal.
5+
6+
You may want to build it first the way it is, in order to get familiar with the
7+
build process. Then you may want to modify some of the files and add new files.
8+
9+
The files that you SHOULD NOT modify are
10+
11+
IJMacros.txt
12+
ImageCompare.cxx
13+
CMakeTemplate.txt
14+
15+
The files that you will NOT need for a submission are
16+
17+
README.md (the file that you are reading).
18+
19+
20+
The files that you will need to modify are
21+
22+
CMakeLists.txt
23+
ImageCopy.cxx
24+
img1.png
25+
26+
The `CMakeLists.txt` file is actually built from the `CMakeTemplate.txt` above.
27+
You want to edit this file and put the details of your own project. In
28+
particular, add the names of the `.cxx` files that must be compiled in order to
29+
build your source code.
30+
31+
The `ImageCopy.cxx` is a trivial example of a filter that don't do anything. It
32+
is just a bogus example of how to write the code. You will not need this
33+
file of a submission.
34+
35+
The `img1.png` is an input file for the test. You don't need this file for a
36+
submission. It must be replaced with the normal input of your algoritm, as well
37+
as the output images that will allow the testing system to verify that your
38+
algorithm is working as advertised in your paper.
39+
40+
Post any questions to the [ITK users discussion forum](https://discourse.itk.org/).

0 commit comments

Comments
 (0)