Resolution ][ README
====================

This is the README file for Resolution ][ Version 1.0. Please read
this file in its entirety before attempting to use Resolution ][.

INTRODUCTION
------------

Resolution ][ is a programmer's API library for developing Apple ][
software using the Apple ][ double-high-resolution graphics mode.

The double-high-resolution graphics mode provides the highest graphics
quality for all 8-bit Apple ][ models. The Apple IIGS also supports
double-high-resolution graphics, although it includes additional,
higher-quality graphics capabilities. However, the Apple ][ BASIC and
ROM interface does NOT provide any double-high-resolution graphics
routines.

The double-high-resolution graphics mode presents a memory layout,
pixel arrangement, and color determination that is nonlinear and follows
a counterintuitive addressing convention. Because of this phenomenon,
working with double-high-resolution graphics can be very difficult,
even for simple tasks such as pixel and line rendering.

Resolution ][ aims to fills this gap by providing easy-to-use
double-high-resolution graphics routines and primitives.

The goals for Resolution ][ are as follows:
- Fast pixel rendering wherever possible
- Minimal memory footprint wherever possible
- Compatibility with all Apple ][ models that support the
  double-high-resolution graphics mode
- Full support for monochrome and color graphics
- Compatibility with all versions of DOS 3.3 and ProDOS
- Easy-to-use API for developing assembly language and AppleSoft BASIC
  applications

Resolution ][ is Copyright (C) 2000 by Arthur Jerijian and distributed
under a free software license agreement similar to the MIT License.
Resolution ][ is conformant to the Open Source definition, as described
at the Open Source Web page (http://www.opensource.org). For a full copy
of the license, refer to the LICENSE.txt file.

The Resolution ][ package includes source code, 6502 binary images,
Apple ][ memory dumps, and Apple ][ disk images. Refer to the README.txt
file in each subdirectory for more information about their contents.

Refer to the BUILD.txt file for information on building Resolution ][.
Refer to the PROGRAMMER.txt file for information on developing applications
with Resolution ][. Refer to the TECHNICAL.txt file for technical
information on the Apple ][ double-high-resolution graphics mode.
Refer to CHANGES.txt for a summary of changes from previous Resolution ][
releases.

FEATURES
--------

Resolution ][ includes the following features:

- Full support for the Apple ][ double-high-resolution graphics mode

- 560 x 192 monochrome resolution, 140 x 192 color resolution

- Color graphics with up to 16 colors

- Graphics primitives for filling backgrounds and drawing pixels and lines

- Support for all versions of DOS 3.3 and ProDOS

- Minimal memory and zero page footprint wherever possible

- Interface for writing 6502 assembly language programs

- Support for all versions of AppleSoft BASIC

The following features are planned for future releases of Resolution ][:

- Easy-to-use interface for AppleSoft BASIC programs. Currently,
  AppleSoft BASIC applications must use a series of POKE, PEEK, and CALL
  commands to perform a Resolution ][ task.

- Routines for additional drawing primitives: ellipse, filled ellipse,
  rectangle, and filled rectangle

- Support for "blitting" -- the ability to move regions of graphics
  within the display or across a memory buffer

- Support for streaming the display into an uncompressed GIF image
  or other common uncompressed bitmap file formats

- Support for rendering text using fixed-width and proportional
  bitmap fonts

- Speed enhancements and improvements. Even though many speed
  optimizations are implemented in Resolution ][, pixel rendering can
  still be optimized further to guarantee fast graphics performance.

SYSTEM REQUIREMENTS
-------------------

The Resolution ][ library, and all applications built against
Resolution ][, require an Apple ][ machine or emulator that supports
the double-high-resolution graphics mode. The following systems are
supported:

- Enchanced Apple //e with 128k or more RAM and an enhanced
  80-column card. If you look at the sticker next to the Open-Apple
  key (on the power light), the word "Enhanced" should be inscribed
  on it. If your Apple //e is not enhanced, or if it has less than
  128k of RAM, Resolution ][ WILL NOT WORK. Resolution ][ should
  work fine on the Platinum Apple //e.

- All models of Apple //c, //c+, and IIGS.

- All modern Apple ][ emulators that support the
  double-high-resolution graphics mode. For more information, consult
  the emulator documentation.

Building the Resolution ][ source code requires an MS-DOS, Windows,
Macintosh, or UNIX system capable of running the xa65 cross-assembler package
(available at http://www.tu-chemnitz.de/~fachat/c64/xa/index.html).
For more information on building Resolution ][, refer to the BUILD.txt file.
Currently, Resolution ][ can NOT be built on an Apple ][ machine unless
the syntax for all directives in the source code is changed to match
the format recognized by Apple ][ assemblers.

I develop and test Resolution ][ on a Linux system running the KEGS
Apple IIGS emulator. Special thanks goes to Kent Dickey for creating
this wonderful emulator. For more information, visit the KEGS emulator
Web page (http://www.psn.net/~kentd/kegs/). Once I understand the
mechanics of file transfer between the Apple ][ and my PC, I will then
be able to test Resolution ][ on a real Apple IIGS.

FEEDBACK
--------

To report bugs or send feedback related to Resolution ][, please send
me an email. My e-mail address is sacredring@hotmail.com .
I welcome the following messages:
- bug reports
- feature suggestions
- test results. I encourage all owners of supported Apple ][ models
  to further test Resolution ][.
- praise and criticism
- information about your Apple ][ Web site, if you administer one

Unfortunately, I cannot accept the following types of e-mail:
- flames of all kinds
- commercial advertisements
- SPAM
- questions that ask me when the next version will be released.
  I cannot predict release dates for this project.
- messages telling me that the Apple ][ is dead. Actually, this
  architecture is alive and kicking in many circles, including some
  schools and businesses.
- messages recommending me to vote for a particular political
  candidate, whether it's related to computing or to national government.
- software patches. I only reject patches because of copyright
  ownership considerations. This may change in the future.
