_____ _ _       _   _            _    
|  ___| (_)_ __ | | | | __ _  ___| | __
| |_  | | | '_ \| |_| |/ _` |/ __| |/ /
|  _| | | | |_) |  _  | (_| | (__|   < 
|_|   |_|_| .__/|_| |_|\__,_|\___|_|\_\
----------|_|---------------------------------------------------------------
README.txt                                             version 1.10, 3/18/01

Written 1999-2001 Douglas I. Anderson

Released under GNU Public License.  See http://www.gnu.org


Description
===========
FlipHack is a HackMaster hack for PalmOS that lets you rotate your
screen 90, 180, and 270 degrees (made possible because the screen is
square under all current devices).  It was tested under versions 2.0, 3.0,
3.1, 3.3, and 3.5.  It has been tested on many devices out there (by users).
As of Feb 2001, the only known device that has been reported to not work
is the TRG device.  It will probably work under version 1.0 (it was 
designed to at least).  It may even work on future OS versions (it tries to 
detect changes), but who knows.

Why is this useful you ask?  I dunno...maybe to mount the device somewhere,
maybe to make the IR on the Handspring Visor on the top of the device.  
Maybe because it's more comfortable to hold the device on the side.  Maybe 
just for the heck of it.


Requirements
============
* A device running version PalmOS.
* Approximately 17K available memory.
* The HackMaster application from DaggerWare or an appropriate competitor.  
    - To get a copy of Hackmaster, go to:
      <http://www.daggerware.com/hackmstr.htm>.  Note that HackMaster is
      shareware.  Please pay for it if you use it.
    - To get a copy of X-Master, a free version of Hackmaster, go to:
      <http://www.linkesoft.com>.  If you're running on OS < 3.5, make
      sure you are using X-Master 1.3 or later.


Installation / Usage
====================
Back up your data.  FlipHack does some pretty low-level hacking.  Besides,
it's always good to back up before installing a new hack.

If you haven't already installed HackMaster (or an equivalent), do that 
first.

Now, simply install the "FlipHack.prc" file as you would any
other ".prc" file.  If you have any previous version installed, uninstall
it first (_very_ important).

Go into HackMaster and install FlipHack (click on the checkbox next to it).
Now, to flip the screen click on the "+" for FlipHack and then click on
one of the arrows.  Note that if you're running in an untested 
environment, you might get some warnings the first time you try to rotate
the screen.

If you're interested in "on the fly" flipping (not through the Hackmaster
application), see the include "DA"s by Hoshi Takanori.


Legal Junk & Distribution
=========================
This program and code are Copyright 1999-2001 Douglas Anderson.  It may 
also be Copyright by Handspring, as they were/are my employer.  
I would like to thank them for letting me distribute this program under GPL.

This code is released under GPL and is subject to the terms of the GPL.  
For details, see <http://www.gnu.org>.  

I request (but do not require) copies of any disk/CD-ROM/etc that contains
FlipHack.


Contact Info
============
Probably the easiest way to contact me is via e-mail.  However, I always
appreciate getting real mail...  I will definitely think you're cooler if
you send me real mail.  

      e-mail:  da AT byteswapped.com
      web:     http://www.byteswapped.com/palm/
      address: Doug Anderson
               2235 California St. #205
               Mountain View, CA 94040
...hope to hear from you.


What else to do
===============
Here are things you can do if you want to help out (in no particular
order of importance):

* A screen benchmarking program to help test optimizations.
* Optimizations.  4 bit and 8 bit could be quite slow.
* More modes for double buffering (maybe separate programs)
  - Mirror modes (horizontal and vertical)
  - backdrop mode (yay!)
* Better central management for double-buffering.  Right now, we're
  limited to stack-like behavior of installation and deinstallation.
* Make code friendly to different compilers (GNU/Windows Codewarrior)
* Rotate digizier area (for writing graffiti sideways).  There is a
  hack by Hoshi Takanori included that does this, but integrating it
  into FlipHack would make it much faster.  I'd also like to do a little
  better mapping.
* Fix the emulator (which is also open source) to deal with the hack
  better (right now, you need a special version of the hack--see
  README.code in the source distribution)
* Test under 1.0
* Persistent angle across resets.
* Use hardware flipping support of SED 1375 in Palm IIIc (it can rotate
  90 degrees for you)
* 16 bit, 24 bit, 32 bit support in the double-buffering code


Known bugs / Conflicts
======================
* Will not work well with some other programs that access the screen
  directly or install their own screen buffer.

* Doesn't work well with the digitizer panel (just reset your device if you
  get stuck in there).
  
* There have been reports of the TRG devices not working with FlipHack.

* The Sony Clie has problems with FlipHack.  I have included a fix that
  Clie users should install: Clie ScreenLock Fix.
  
* Launcher III 1.5.2 - Cosmetic problem where the bottom of the screen
  doesn't get redrawn.

* TealEcho 1.4.3 - Crashes when you try to write stuff.

* On OS versions before 3.5, FlipHack will not work with X-Master before
  version 1.3



Version History
===============
1.10,  3/18/01 - Better error reporting; now includes Clie ScreenLock fix
                 to support the Sony Clie; better support for X-Master
                 on older versions of PalmOS; now has debug labels in
                 more of the code to make debugging easier.
1.10b, 2/19/01 - Visor Prism supported with hardware flipping (very fast 
                 and compatible); OS 3.5.2 listed as supported; VZ listed 
                 as supported; X-Master friendly (detects X-Master 
                 uninstall).
1.00,  7/8/00  - Official 1.0 release--just version number changed from b2.
1.0b2, 7/1/00  - Improved handling of error conditions (among other
                 things, fixed a problem when launching PalmVNC); attempt 
                 at forward compatibility.
1.0b,  ------- - 4-bit and 8-bit modes added; OS 3.5+ support;
                 better handling of error conditions                 
0.96,  1/22/00 - Made work under OS 2.0
0.95,  1/22/00 - Initial public release.