
     --------------------------------------------------------------------
                    Nemesis Indicator v2.01 (August 5, 2017)
                      Written by Daniel Hedberg, New Beat

                             http://nb.atari.org
     --------------------------------------------------------------------



     FREEWARE
     --------------------------------------------------------------------
     Nemesis Indicator is freeware. It may be copied and passed on freely
     providing it is left unchanged and all files are included.

     PLEASE READ!
     Despite the fact that this program is freeware, and you have no
     obligations at all towards me, I would appreciate some feedback
     if you find this program useful. Contact details can be found at
     the end of this text file. Thank you.


     FILE INFORMATION
     --------------------------------------------------------------------
     A complete archive includes the following files:

       NIND201\
         NIND.PRG       NInd memory resident program
         NINDCONF.CPX   NInd configuration CPX
         NISWITCH.ACC   NInd accessory
         NIND8.DAT      Default graphics (same as NIND8_1.DAT)
         NIND16.DAT     Default graphics (same as NIND16_1.DAT)
         DOC\
           NIND.TXT       Documentation (this file)
           UPDATES.TXT    Version history information
         GRAPHICS\
           NIND8_1.DAT    Default graphics (small font)
           NIND8_2.DAT    Alternative graphics (small font)
           NIND16_1.DAT   Default graphics (large font)
           NIND16_2.DAT   Alternative graphics (large font)
           NIND16_3.DAT   Alternative graphics (large font)
           NIND16_4.DAT   Alternative graphics (large font)
           NIND16_5.DAT   Alternative graphics (large font)
           NIND16_6.DAT   Alternative graphics (large font)
         SOURCES\
           MAKEFILE       Makefile for GNU make and the vasm assembler to
                          build the NInd memory resident program
           MAKEFILE.ACC   Makefile for GNU make and the vasm assembler to
                          build the NInd accessory
           NIND.S         NInd memory resident program source code
           NISWITCH.S     NInd accessory source code
           INCLUDE.DIR\
             G_COOKIE.S     NInd include (Cookie functions)
             P_COOKIE.S     NInd include (Cookie functions)
             NEMESIS.S      NInd include (Nemesis functions)
             OS\
               _GEMDOS.S      NInd include (GEMDOS macros)
               _XBIOS.S       NInd include (XBIOS macros)
               _AES.S         NInd include (AES macros)
               _LINE_A.S      NInd include (LINE A macros)
               _BUFFERS.S     NInd include (VDI/AES buffers)
           NINDCONF.CPX\
             CPXDATA.H      CPX data structures
             CPXSTART.S     NInd CPX startup file
             MAKEFILE       Makefile for GNU make and the vbcc C compiler
                            to build the NInd CPX
             NINDCONF.C     NInd CPX C source code
             NINDCONF.H     NInd CPX C header
             NINDCONF.HDR   NInd CPX header
             NINDCONF.ICN   NInd CPX icon
             NIND_RSC.DFN   NInd CPX resource definition file
             NIND_RSC.RSC   NInd CPX resource file
             NIND_RSC.RSH   NInd CPX resource C data
             VBCC\
               CPX16          Config file for vbcc to build CPXs



     OVERVIEW
     --------------------------------------------------------------------
     Nemesis Indicator is a small memory resident program for Atari
     Falcon030 computers equipped with the Nemesis accelerator from Titan
     Designs Ltd.

     It displays the current Nemesis state (16/32 MHz, 20/40 MHz, or
     24/48 MHz) in the upper right corner of the screen. The first number
     is the clock frequency of the CPU and the BUS, while the number after
     the slash is the clock frequency of the DSP.

     The graphics used for displaying the Nemesis state can be changed
     and customized to your wishes. Read more under CUSTOM GRAPHICS.

     Nemesis Indicator also allows the Nemesis state to be changed by a
     simple mouse click. Clicking the left mouse button while the mouse
     cursor is within the display area will decrease the speed of the
     Nemesis, clicking the right mouse button will increase the speed.

     Since version 2.0 the Nemesis Indicator also includes a CPU power
     saver feature that, when enabled, will turn off the Nemesis after a
     specified number of minutes of no user activity. Whenever user
     activity is detected again, the most recent Nemesis state will be
     restored. Read more under CPU POWER SAVER.

     The Nemesis Indicator can be configured using the included
     NINDCONF.CPX. The NISWITCH.ACC file is an accessory that can be
     used to disable the Nemesis Indicator. When disabled, both the
     indicator and the CPU power saver are disabled.


     HOW TO USE
     --------------------------------------------------------------------
     To run Nemesis Indicator, just double click the NIND.PRG file from
     the Desktop. The program file can also be installed in the AUTO
     folder. Would you like to use customized graphics for the Nemesis
     Indicator, copy the files NIND8.DAT and NIND16.DAT to the AUTO
     folder as well.

     NEMESIS.PRG (included with the Nemesis accelerator) must be run
     before NIND.PRG. NEMESIS.PRG installs a cookie that is is needed by
     Nemesis Indicator.

     To be able to configure the Nemesis Indicator, copy the NINDCONF.CPX
     file to your CPX directory path, and reload the CPXs in the control
     panel (or reboot the computer). The Nemesis Indicator CPX is named
     NInd Config. Any changes to the configuration will be applied to
     the Nemesis Indicator when clicking OK. By clicking Save, the
     configuration will be saved to the CPX file and applied
     automatically at every start-up, as long as the CPX is not
     deactivated or removed from the control panel. The CPX also works
     with earlier versions of the Nemesis Indicator.

     The accessory is optional. Install it by copying it to the root
     directory of your boot drive and reboot the computer. The file can
     also be used as a normal program by changing the file extension
     to a valid extension (e.g. PRG, APP, etc).


     CUSTOM GRAPHICS
     --------------------------------------------------------------------
     The graphics used for displaying the Nemesis state can be
     customized. Edit the files NIND8.DAT and NIND16.DAT to make them
     suit your needs, and if necessary, copy the files to the AUTO
     folder. The files will be read by NIND.PRG when started the next
     time. Note that if Nemesis Inidicator is already running you need to
     reboot the computer first.

     For easy editing, the NIND8.DAT and NIND16.DAT files are pure ASCII
     files with simple ASCII graphics that are converted to bitmap
     graphics when read and parsed by NIND.PRG. The NIND8.DAT file is
     used in non-interlaced RGB video modes and double line VGA video
     modes, or any other video modes making use of the smaller system
     font. The NIND16.DAT file is used for all video modes utilizing
     the larger system font.

     The files should consist of three paragraphs with 8, respectively 16
     lines each. The three paragraphs represent the 3 different Nemesis
     states (OFF, LOW, HI). Each line should be 64 characters long and
     consist of only dots and hash signs. Dots are used for transparent
     pixels, while hash signs are used for solid pixels. Any other
     character, line breaks included, is ignored when the files are read.

     Some predefined graphics can be found in the GRAPHICS folder. To
     use any of the files, copy them to the same location as NIND.PRG
     and rename them to NIND8.DAT and NIND16.DAT respectively.

     If you create some graphics that you think would be of interest to
     others, do not hesitate to contact me. I would be happy to include
     it in the next version of the Nemesis Indicator.


     CPU POWER SAVER
     --------------------------------------------------------------------
     The CPU power saver feature of Nemesis Indicator will turn off the
     Nemesis after a number of minutes of user inactivity (no mouse or
     keyboard activity). The power saver feature can be configured in
     the NInd Configuration CPX.

     The power saver feature, if enabled, can be temporarily inactivated
     by placing (and leaving) the mouse cursor on top of the Nemesis
     Indicator in the upper right corner of the screen. This is useful
     if you leave the computer on for an extended period of time
     computing something, and do not want it to slow down.


     TECHNICAL NOTES
     --------------------------------------------------------------------
     Nemesis Indicator is a memory resident program. It installs itself
     in the operating system's VBL queue. Memory usage is less than 22kb
     and CPU usage is very low (not noticable under normal operation).


     SOURCE CODE
     --------------------------------------------------------------------
     The source code for all parts of the Nemesis Indicator is included
     in the distribution under the SOURCES folder.

     The NInd memory resident program and the accessory were originally
     written in the Devpac assembler, but can also be built using the
     excellent vasm cross-assembler (in Devpac mode). A makefile GNU
     Make and vasm can also be found in the SOURCES folder. Some changes
     to the include directories in the source files are most likely
     required to make it build on your computer.

     The CPX was written in C and built with the vbcc cross-compiler. It
     needs GEMlib (not included). All source code along with a makefile
     for GNU Make and vbcc can be found in the NINDCONF.CPX folder.


     HOW TO CONTACT ME
     --------------------------------------------------------------------
     Feel free to contact me for any reason. Suggestions how to improve
     Nemesis Indicator or bug reports are welcome!

     E-Mail: daniel.hedberg@gmail.com
        WWW: http://nb.atari.org
