Commit 3e481de3 authored by Barry Warsaw's avatar Barry Warsaw

Updated documentation, and bump the version number to 1.2.

parent 3eec7620
...@@ -2,7 +2,7 @@ Pynche - The PYthonically Natural Color and Hue Editor ...@@ -2,7 +2,7 @@ Pynche - The PYthonically Natural Color and Hue Editor
Contact: Barry A. Warsaw Contact: Barry A. Warsaw
Email: bwarsaw@python.org Email: bwarsaw@python.org
Version: 1.1 Version: 1.2
Introduction Introduction
...@@ -31,7 +31,8 @@ Introduction ...@@ -31,7 +31,8 @@ Introduction
the license only for rgb.txt and both files are in the X/ the license only for rgb.txt and both files are in the X/
subdirectory. subdirectory.
Pynche is pronounced `Pinch-ee'. Pynche is pronounced: Pin'-chee
Running Standalone Running Standalone
...@@ -66,14 +67,15 @@ Running Standalone ...@@ -66,14 +67,15 @@ Running Standalone
many shells, it is optional in the spec (e.g. #45dd1f is the many shells, it is optional in the spec (e.g. #45dd1f is the
same as 45dd1f). same as 45dd1f).
Running as a Modal Dialog Running as a Modal Dialog
Pynche can be run as a modal dialog, inside another application, Pynche can be run as a modal dialog, inside another application,
say as a general color chooser. In fact, Grail 0.6 already uses say as a general color chooser. In fact, Grail 0.6 uses Pynche
Pynche and a future version of IDLE may as well. Pynche supports and a future version of IDLE may as well. Pynche supports the API
the API implemented by the Tkinter standard tkColorChooser module, implemented by the Tkinter standard tkColorChooser module, with a
with a few changes as described below. By importing pyColorChooser few changes as described below. By importing pyColorChooser from
from the Pynche package, you can run the Pynche package, you can run
pyColorChooser.askcolor() pyColorChooser.askcolor()
...@@ -128,6 +130,7 @@ Running as a Modal Dialog ...@@ -128,6 +130,7 @@ Running as a Modal Dialog
[*] these arguments must be specified the first time [*] these arguments must be specified the first time
askcolor() is used and cannot be changed on subsequent calls. askcolor() is used and cannot be changed on subsequent calls.
The Colorstrip Window The Colorstrip Window
The top part of the main Pynche window contains the "variation The top part of the main Pynche window contains the "variation
...@@ -148,12 +151,13 @@ The Colorstrip Window ...@@ -148,12 +151,13 @@ The Colorstrip Window
Click on "Update while dragging" if you want Pynche to update the Click on "Update while dragging" if you want Pynche to update the
selected color while you drag along any variation strip (this will selected color while you drag along any variation strip (this will
be slower). Click on "Hexadecimal" to display the arrow numbers be a bit slower). Click on "Hexadecimal" to display the arrow
in hex. numbers in hex.
There are also two shortcut buttons in this window, which There are also two shortcut buttons in this window, which
auto-select Black (0/0/0) and White (255/255/255). auto-select Black (0/0/0) and White (255/255/255).
The Proof Window The Proof Window
In the lower left corner of the main window you see two larger In the lower left corner of the main window you see two larger
...@@ -172,6 +176,7 @@ The Proof Window ...@@ -172,6 +176,7 @@ The Proof Window
Nearest chip. The other names are "aliases" and they are visible Nearest chip. The other names are "aliases" and they are visible
in the Color List Window (see below). in the Color List Window (see below).
The Type-in Window The Type-in Window
At the lower right of the main window are three entry fields. At the lower right of the main window are three entry fields.
...@@ -185,12 +190,14 @@ The Type-in Window ...@@ -185,12 +190,14 @@ The Type-in Window
value!) Click on "Hexadecimal" to display and enter color values value!) Click on "Hexadecimal" to display and enter color values
in hex. in hex.
Other Views Other Views
There are three secondary windows which are not displayed by There are three secondary windows which are not displayed by
default. You can bring these up via the "View" menu on the main default. You can bring these up via the "View" menu on the main
Pynche window. Pynche window.
The Text Window The Text Window
The "Text Window" allows you to see what effects various colors The "Text Window" allows you to see what effects various colors
...@@ -214,6 +221,7 @@ The Text Window ...@@ -214,6 +221,7 @@ The Text Window
new text will be inserted as you type. The insertion cursor only new text will be inserted as you type. The insertion cursor only
has a background. has a background.
The Color List Window The Color List Window
The "Color List" window shows every named color in the color name The "Color List" window shows every named color in the color name
...@@ -235,6 +243,7 @@ The Color List Window ...@@ -235,6 +243,7 @@ The Color List Window
the selected color has no matching color name you'll see the selected color has no matching color name you'll see
"<no matching color>" in the Aliases window. "<no matching color>" in the Aliases window.
The Details Window The Details Window
The "Details" window gives you more control over color selection The "Details" window gives you more control over color selection
...@@ -288,6 +297,7 @@ The Details Window ...@@ -288,6 +297,7 @@ The Details Window
+10 == Control Right Arrow +10 == Control Right Arrow
+25 == Shift Right Arrow +25 == Shift Right Arrow
Keyboard Accelerators Keyboard Accelerators
Alt-w in any secondary window dismisses the window. In the main Alt-w in any secondary window dismisses the window. In the main
...@@ -295,6 +305,7 @@ Keyboard Accelerators ...@@ -295,6 +305,7 @@ Keyboard Accelerators
Alt-q in any window exits Pynche (except when running as a modal). Alt-q in any window exits Pynche (except when running as a modal).
Persistency Persistency
Pynche remembers various settings of options and colors between Pynche remembers various settings of options and colors between
...@@ -325,6 +336,7 @@ Persistency ...@@ -325,6 +336,7 @@ Persistency
you really want to do this, use /dev/null as the init file, using you really want to do this, use /dev/null as the init file, using
--initfile. --initfile.
Color Name Database Files Color Name Database Files
Pynche uses a color name database file to calculate the nearest Pynche uses a color name database file to calculate the nearest
...@@ -352,9 +364,10 @@ Color Name Database Files ...@@ -352,9 +364,10 @@ Color Name Database Files
update the appropriate windows. If not, it will bring up an error update the appropriate windows. If not, it will bring up an error
dialog. dialog.
To Do To Do
Here's a brief list of things I want to do: Here's a brief list of things I want to do (some mythical day):
- Better support for resizing the top level windows - Better support for resizing the top level windows
...@@ -365,6 +378,8 @@ To Do ...@@ -365,6 +378,8 @@ To Do
- Support setting the font in the text view - Support setting the font in the text view
- Support distutils setup.py for installation
I'm open to suggestions! I'm open to suggestions!
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment