home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / pc / armedit_1 / ReadMe
Text File  |  1997-12-06  |  8KB  |  190 lines
  1. File        : ReadMe
  2. Date        : 07-Dec-97
  3. Author      : © A.Thoukydides, 1995, 1996, 1997
  4. Description : Help file for the "ARMEdit" suite of software.
  5.  
  6.  
  7. INTRODUCTION
  8.  
  9. ARMEdit is a suite of utilities for use with Acorn and Aleph One PC cards. It
  10. consists of a RISC OS module, a desktop front-end application, several DOS
  11. executables, a DOS device driver, and support for third party programmers.
  12.  
  13. Limited support is provided for the Acorn software PC emulator. Due to the
  14. lower level of programmer support provided, some features of the ARMEdit
  15. suite may not operate as expected when used with the software emulator.
  16.  
  17. To install and try the software quickly, follow the instructions in the
  18. Docs.QuickStart file.
  19.  
  20. This suite of software is FreeWare; it may be freely used and copied.
  21. However, I retain full copyright of all files except Info-ZIP's UnZip
  22. utility. See the section on "LEGAL MATTERS" for more details.
  23.  
  24.  
  25. FILE LIST
  26.  
  27. This is the complete lists of files contained in this ARMEdit distribution.
  28. All of these files must be included unmodified if distributed further.
  29.  
  30.     ReadMe              This file.
  31.  
  32.     !ARMEdit            The front-end application. This is only required for
  33.         !Help           some of the functionality of the suite.
  34.         !Run
  35.         !Run2           The application directory also contains the ARMEdit
  36.         !Sprites        module that is always required. With early versions
  37.         !Sprites22      of the PC front-end software it is necessary to load
  38.         PCQuit          the module before starting the PC front-end.
  39.         Configure       
  40.             !Run        The PCQuit file may be modified, or used as an
  41.             !RunImage   example of an obey file to be run when the PC
  42.             !Sprites    front-end is quit. The supplied example file kills
  43.             !Sprites22  all PC related modules.
  44.             Messages
  45.             Res
  46.             Sprites
  47.             Sprites22
  48.             UnZip
  49.         Install
  50.             CodeARM
  51.             CodePC
  52.             Device
  53.             Utilities
  54.         Launch
  55.             !Run
  56.             !RunImage
  57.         Resources
  58.             !RunImage
  59.             ARMEdit
  60.             Banner
  61.             Ensure
  62.             Messages
  63.             Res
  64.             Templates
  65.             Title
  66.             Title22
  67.  
  68.     Docs                The rest of the documentation. The different files
  69.         ARMEDIT         are described below. Read these before reporting any
  70.         Banner          problems.
  71.         Code
  72.         Contacts
  73.         Device
  74.         Ensure
  75.         FrontEnd
  76.         GETFILE
  77.         HPC
  78.         Module
  79.         OSCLI
  80.         PUTFILE
  81.         QuickStart
  82.         Talk
  83.  
  84. Other files are stored compressed as Zip archives in the "!ARMEdit.Install"
  85. directory. These may be extracted using the "Install..." option from the
  86. iconbar menu. Alternatively, SparkFS or Info-ZIP's UnZip utility may be used
  87. to decode the files by hand.
  88.  
  89.  
  90. DOCUMENTATION
  91.  
  92. For more information on the ARMEdit suite please refer to the documents in
  93. the "Docs" sub-directory. The files are:
  94.  
  95.     ARMEDIT     - Documentation for the "ARMEDIT.COM" PC executable that
  96.                   allows DOS files to be edited using RISC OS editors.
  97.     
  98.     Banner      - Documentation for the "Banner" utility used by the
  99.                   front-end to display a title window.
  100.  
  101.     Code        - Documentation required for writing extra utilities for use
  102.                   with the ARMEdit module or front-end.
  103.  
  104.     Contacts    - Contact details, including how to obtain upgrades to
  105.                   ARMEdit and the PC card software.
  106.  
  107.     Device      - Documentation for the "ARMEDIT.SYS" PC device driver that
  108.                   allows access to RISC OS filestore from DOS or Windows 95.
  109.           
  110.     Ensure      - Documentation for the "Ensure" utility used by the
  111.                   front-end to load required system modules.
  112.     
  113.     FrontEnd    - Documentation for the "!ARMEdit" front-end that enhances
  114.                   the functionality of the suite and allows simpler
  115.                   installation and configuration.
  116.         
  117.     GETFILE     - Documentation for the "GETFILE.COM" PC executable that
  118.                   allows files to be copied from RISC OS to DOS.
  119.     
  120.     HPC         - Documentation intended for other PC card device driver
  121.                   developers, detailing some of the calls that may be made
  122.                   to the ARMEdit module from the PC processor.
  123.     
  124.     Module      - Documentation for the "ARMEdit" module that provides vital
  125.                   support for all parts of the system.
  126.     
  127.     OSCLI       - Documentation for the "OSCLI.COM" PC executable that allows
  128.                   RISC OS *commands to be executed from DOS.
  129.     
  130.     PUTFILE     - Documentation for the "PUTFILE.COM" PC executable that
  131.                   allows files to be copied from DOS to RISC OS.
  132.  
  133.     QuickStart  - A short introduction to installing and using the main
  134.                   features of the ARMEdit suite of software.
  135.  
  136.     Talk        - Documentation required for using the "!ARMEdit" front-end
  137.                   from new PC utilities.
  138.  
  139.  
  140. LEGAL MATTERS
  141.  
  142. The "ARMEdit" suite of software and documentation is supplied "as is"; no
  143. warranty, express or implied, of the merchantability of this software or its
  144. fitness for any particular purpose is given. In no circumstances shall the
  145. author, or any provider or distributor of this software, be liable for any
  146. damage, loss of profits, or any indirect or consequential loss arising out of
  147. the use of this software or inability to use this software.
  148.  
  149. This software is FreeWare. Permission is granted for anyone to distribute it
  150. unchanged and in its entirety, providing that no profit is made in the
  151. process. The "ARMEdit" suite may not be distributed if modified or
  152. incomplete; neither may it be distributed without this documentation.
  153. However, the "Banner" application and "Ensure" utility may be used and
  154. distributed independently providing the terms in the relevant documentation
  155. file are complied with.
  156.  
  157. The install option uses Info-ZIP's UnZip utility to extract files from an
  158. archive. Info-ZIP's software (Zip, UnZip and related utilities) is free and
  159. can be obtained as source code or executables from various sources. See the
  160. Docs.Contacts file for more details.
  161.  
  162. To use this suite, or any part of it, as part of a system or other
  163. application that is for sale (for however much and for whatever reasons) or
  164. released as copyright material then the author's express permission in
  165. writing must be obtained. The author maintains copyright on all the material
  166. supplied and reserves the right to change these conditions at any time
  167. without notice.
  168.  
  169.  
  170. ACKNOWLEDGEMENTS
  171.  
  172. I would like to the thank the following people for their contributions to the
  173. development of this software:
  174.  
  175.     Acorn Computers - The Risc PC, RISC OS and the ObjAsm assembler.
  176.     Aleph One       - Producing the PC cards, information and support.
  177.     Oliver Betts    - His excellent RISC OS LineEditor module.
  178.     Neil Bingham    - Promoting ARMEdit, and numerous constructive comments.
  179.     Ray Dawson      - Suggestion for improvements to early versions.
  180.     Paul Gardiner   - Information about Windows 95 long filenames.
  181.     John Harrison   - Bug reports and suggestions for improvements.
  182.     Mike Hobbs      - Useful comments during early development and testing.
  183.     Dominic Symes   - The brilliant !Zap editor; get a copy immediately.
  184.     Tim Tyler       - Making !Zap even better than ever.
  185.     Brian Tucker    - Pointing out a bug that many others did not notice.
  186.     Robin Watts     - !Larger, the greatest backdrop program ever.
  187.  
  188. Thanks also to all the beta-testers who have helped with the development and
  189. testing of this software.
  190.