Skip to content

Commit 9320023

Browse files
committed
add license, fix readme
Signed-off-by: Jaime Silvela <[email protected]>
1 parent 7ffe797 commit 9320023

File tree

2 files changed

+32
-9
lines changed

2 files changed

+32
-9
lines changed

LICENSE.txt

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Jaime Silvela
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ I wrote this code in 2001 for my thesis on image processing, and
44
from that I got an article published:
55

66
*Breadth-First Search and Its Application to Image Processing Problems*,
7-
published IEEE TRANSACTIONS ON IMAGE PROCESSING, VOL. 10, NO. 8, AUGUST 2001.
7+
published on IEEE Transactions on Image Processing, VOL. 10, NO. 8, August 2001.
88
[link](https://silvela.org/jaime/BFSpaper.pdf)
99

1010
I have made no functionality change since then, nor have I tried to update
@@ -14,14 +14,14 @@ Tested on a Raspberry Pi running *stretch*, May 2022.
1414

1515
## Installing
1616

17-
You need libtiff to be installed.
17+
You need `libtiff` to be installed.
1818
In a Debian-derived system:
1919

2020
``` sh
2121
apt-get install libtiff libtiff-dev
2222
```
2323

24-
If you want to run the GTK+ gui bit, you will need libgtk-dev
24+
If you want to run the GTK+ UI, you will need `libgtk-dev`
2525
too. This was developed way back when, on GTK+ version 2.
2626

2727
``` sh
@@ -47,12 +47,13 @@ The two executables take in a single TIFF image as input, and after
4747
starting, become a command-line interpreter.
4848

4949
For example, we start processing the image `manos/a30000.tif`.
50-
In the terminal where we fired the executables, we type:
50+
In the terminal:
5151

5252
``` sh
5353
./pro-gtk-image manos/a30000.tif
5454
```
5555

56+
Now, we can use the terminal as a REPL.
5657
One or more commands may be issued, followed by a newline.
5758
After each, a GTK+ window will display the result of the command.
5859

@@ -62,24 +63,26 @@ E.g.
6263
threshold 100
6364
```
6465

65-
-> a window opens showing the image after thresholding
66+
a window opens showing the image after thresholding
6667

6768
``` sh
6869
regions
6970
```
7071

71-
-> a window opens showing the image after cleaning the noisy regions
72+
a window opens showing the image after cleaning the noisy regions
7273

73-
The commands may also be chained. An window will open after each command.
74+
The commands may also be chained. For example:
7475

7576
``` sh
7677
threshold 100 regions
7778
```
7879

80+
… a window will open after each command.
81+
7982
### Non-graphical executable
8083

81-
The non-graphical executable does not produce a window, of course.
82-
We should write out to a TIFF file to show progress.
84+
The non-graphical executable does not produce a window with the results,
85+
of course. We should write out to a TIFF file to show progress.
8386

8487
``` sh
8588
% ./pro-image manos/a30000.tif

0 commit comments

Comments
 (0)