annotate Readme.html @ 13:3feeb953d9ae

val -> var
author David Barts <n5jrn@me.com>
date Sat, 18 Jul 2020 14:23:02 -0700
parents 70b4d11ebbb9
children 404eb7e57fe6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
1 <!DOCTYPE html>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
2 <html>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
3 <head>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
5 <title>ImagePrep Read Me</title>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
6 <style>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
7 html { font-family: "TeX Gyre Schola", serif; }
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
8 h1, h2, h3, h4, h5, h6 { font-family: "Avenir Next", sans-serif; }
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
9 pre, code, kbd, samp { font-family: "Menlo", monospace; font-size: 85%; }
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
10 </style>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
11 </head>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
12 <body>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
13 <h1>ImagePrep Read Me</h1>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
14 <p>This is a simple program mainly created for my own benefit.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
15 <p>Because it is primarily for my own benefit, it does not build to a
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
16 “clickable” app. That is too much of a pain to implement.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
17 <p>Because I have code to crib, it does contain a help file. It’s pretty
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
18 rudimentary, however.</p>
10
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
19 <p>Because I have code to crib, it does run on a <code>.properties</code>
0
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
20 file, but because coding preferences dialogs is something of a pain, it
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
21 does not contain a preferences or settings dialog, even though there is
10
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
22 some code to crib for both. The <code>.</code><code>properties</code>
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
23 file must be edited by hand* (it will live in the normal place for such
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
24 files on the system being run under). If no such file exists, a default
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
25 one will be created. The only things in it will be the maximum dimension
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
26 to clamp to, where the output file goes by default, and maybe what the
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
27 output file’s name is by default (i.e. a name suffix).</p>
0
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
28 <p>* This program is <em>for my own benefit</em>, and <em>I</em> have no
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
29 problem editing text files, therefore this is reasonable.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
30 <p>Contrary to JpegWasher, which is designed for batch processing, this will
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
31 have more of a “document editor” style of design. Meaning, you open a
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
32 file, you edit it, you save it, you close it.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
33 <p>Upon opening a file, it will be auto-scaled to the specified maximum
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
34 dimension. This will default to the value in the preferences file, but the
10
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
35 user will be able to override it with a command-line argument.</p>
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
36 <p>Ah, the command-line. Because it’s not a full “clickable” app, it is
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
37 launched from the command line, and accepts arguments, much like the old
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
38 days of using X Windows. This is actually <em>more</em> user-friendly for
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
39 my purposes, because it ends up honoring the concept of the current
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
40 working directory. (Directory management is one area where GUI programs
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
41 fall short.)</p>
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
42 <p>The current working directory is the input files directory. Depending on
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
43 how the properties are configured, the output directory is either the
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
44 current working directory, or a specified output file directory. Both
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
45 directories act like a current working directory; the next time an input
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
46 or output dialog is brought up in a given session, it will be in the same
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
47 spot the previous dialog was when it was closed. All this makes it easy to
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
48 rapidly edit files in a directory of images downloaded from a camera,
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
49 without polluting that directory with the edited files.</p>
0
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
50 <p>At that point, the editing step begins. It is extremely simple and is
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
51 limited to rotation. Three types of rotation will be offered, 90°
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
52 clockwise, 180°, and 90° counterclockwise.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
53 <p>The user can rotate the file as many times as s/he wants. Sort of silly,
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
54 but sometimes people are tired and get clockwise and counterclockwise
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
55 confused, so might as well give ’em a chance to fix their mistakes. Plus,
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
56 it would take special effort <em>not</em> to allow this.</p>
10
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
57 <p>Then comes the closing and saving. They are one operation, because that
70b4d11ebbb9 Update Readme.html.
David Barts <n5jrn@me.com>
parents: 0
diff changeset
58 makes the program easier <em>for me</em> to use.</p>
0
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
59 <p>Ideally, I wouldn’t even puts around with making this a GUI app in the
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
60 first place. It’s for my own use, so the command line would be good
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
61 enough. The problem is rotation: it’s a hot mess. There’s really no way to
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
62 do it right save to show the image to a human and let him (me) decide
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
63 which way is up.</p>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
64 </body>
e0efe7848130 Initial commit. Untested!
David Barts <davidb@stashtea.com>
parents:
diff changeset
65 </html>