home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / a / armedit / ReadMe
Text File  |  1997-02-21  |  9KB  |  229 lines
  1. File        : ReadMe
  2. Date        : 21-Feb-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, and support for third party programmers.
  12.  
  13. This release of the software contains some support for the Acorn software PC
  14. emulator. Due to the lower level of programmer support provided, some
  15. features of the ARMEdit suite may not operate as expected when used with the
  16. software emulator - this may be fixed in a later version.
  17.  
  18. ARMEdit is still under development. Some of the components that may be added
  19. or improved are:
  20.     
  21.     An extended OSCLI command that supports the use of TaskWindows and
  22.     processing of VDU sequences prior to display of output.
  23.     
  24.     Enhanced versions of the GETFILE command that support wildcards and
  25.     recursion of subdirectories.
  26.     
  27.     A version of the device driver that supports write operations.
  28.     
  29.     An automatic installer to copy required files into the PC partition, and
  30.     modify any required configuration files.
  31.  
  32. This suite of software is FreeWare; it may be freely used and copied.
  33. However, I retain full copyright. See the section on "LEGAL MATTERS" for more
  34. details.
  35.  
  36.  
  37. FILE LIST
  38.  
  39. This is the complete lists of files contained in this ARMEdit distribution.
  40. All of these files must be included unmodified if distributed further.
  41.  
  42.     !ARMEdit            The front-end application. This is only required for
  43.         !Help           some of the functionality of the suite.
  44.         !Run
  45.         !Run2           The application directory also contains the ARMEdit
  46.         !RunImage       module that is always required. It is normally
  47.         !Sprites        necessary to load the module before starting the PC
  48.         !Sprites22      front-end.
  49.         ARMEdit
  50.         Banner          The PCQuit file may be modified, or used as an example
  51.         Configure       of an obey file to be run when the PC front-end is
  52.             !Run        quit. The supplied example file kills all PC related
  53.             !RunImage   modules.
  54.             Messages
  55.             Res
  56.             Sprites
  57.             Sprites22
  58.         Ensure
  59.         Launch
  60.             !Run
  61.             !RunImage
  62.         PCQuit
  63.         Resources
  64.             Banner
  65.             Banner22
  66.             Messages
  67.             Res
  68.             Templates
  69.  
  70.     Code                Header files and object files required for developing
  71.         ARMFILE/H       extra utilities (both under RISC OS and on the PC).
  72.         ARMEDIT/LIB     See Docs.Code for more details of how to use these.
  73.         CLI/H
  74.         SWI/H
  75.         TALK/H
  76.         h.armeditswi
  77.         o.armeditswi
  78.  
  79.     Docs                The rest of the documentation. The different files
  80.         ARMEDIT         are described below. Read these before reporting any
  81.         Banner          problems.
  82.         Code
  83.         Contacts
  84.         Device
  85.         Ensure
  86.         FrontEnd
  87.         GETFILE
  88.         HPC
  89.         Module
  90.         OSCLI
  91.         PUTFILE
  92.         Talk
  93.         
  94.     PC                  The PC executables. These should be copied directly
  95.         ARMEDIT/COM     from the archive to a PC partition, otherwise the
  96.         ARMEDIT/SYS     filenames are likely to get truncated.
  97.         GETFILE/COM
  98.         OSCLI/COM
  99.         PUTFILE/COM
  100.  
  101.     ReadMe              This file.
  102.         
  103.  
  104. QUICK START
  105.  
  106. Before starting it is worth noting that this software requires a version of
  107. the PC front-end software 1.87 or above. Better performance will be obtained
  108. if PCPro (!PC version 2.00 of higher) is used. The version number is
  109. displayed in the Info window from the icon-bar icon. See the Contacts
  110. documentation for details of obtaining upgrades.
  111.  
  112. To try these programs quickly follow these simple instructions:
  113.  
  114.     Copy the files from the PC directory of the archive into your PC
  115.     partition. If you are unsure of how to do this then read the relevant
  116.     sections of the manuals that came with the computer and PC card.
  117.  
  118.     Load the !ARMEdit front-end (double-click on its icon in a filer window)
  119.     before starting the PC software. This will automatically load the ARMEdit
  120.     module.
  121.     
  122.     Start the PC front-end software.
  123.  
  124.     If you are not at a DOS prompt then obtain one, e.g. from Windows
  125.     double-click on the MS-DOS Prompt icon.
  126.     
  127.     Change to the directory containing the files copied from the PC directory
  128.     of the archive.
  129.     
  130.     Type "OSCLI Help ARMEdit". This should display some familiar looking
  131.     help text.
  132.     
  133.     For information about each of the commands simply append /? after the
  134.     command name, e.g. "PUTFILE /?".
  135.  
  136. To find out more read the documentation files listed below.
  137.  
  138.  
  139. DOCUMENTATION
  140.  
  141. For more information on this set of utilities please refer to the documents
  142. in the "Docs" sub-directory. The files are:
  143.  
  144.     ARMEDIT     - Documentation for the "ARMEDIT.COM" PC executable that allows
  145.                   DOS files to be edited using RISC OS editors.
  146.     
  147.     Banner      - Documentation for the "Banner" utility used by the front-end
  148.                   to display the title window.
  149.  
  150.     Code        - Documentation required for writing extra utilities for use
  151.                   with the ARMEdit module.
  152.  
  153.     Contacts    - Contact details, including how to obtain upgrades to ARMEdit
  154.                   and the PC card software.
  155.  
  156.     Device      - Documentation for the "ARMEDIT.SYS" PC device driver that
  157.                   allows access to RISC OS filestore from DOS.
  158.           
  159.     Ensure      - Documentation for the "Ensure" utility used by the front-end
  160.                   to load required system modules.
  161.     
  162.     FrontEnd    - Documentation for the "!ARMEdit" front-end that enhances
  163.                   the functionality of the suite.
  164.         
  165.     GETFILE     - Documentation for the "GETFILE.COM" PC executable that allows
  166.                   files to be copied from RISC OS to DOS.
  167.     
  168.     HPC         - Documentation intended for other PC card device driver
  169.                   developers, detailing some of the calls that may be made
  170.                   to the ARMEdit module from the PC.
  171.     
  172.     Module      - Documentation for the "ARMEdit" module that provides vital
  173.                   support for all parts of the system.
  174.     
  175.     OSCLI       - Documentation for the "OSCLI.COM" PC executable that allows
  176.                   RISC OS *commands to be executed from DOS.
  177.     
  178.     PUTFILE     - Documentation for the "PUTFILE.COM" PC executable that allows
  179.                   files to be copied from DOS to RISC OS.
  180.  
  181.     Talk        - Documentation required for using the "!ARMEdit" front-end
  182.                   from new PC utilities.
  183.  
  184.  
  185. LEGAL MATTERS
  186.  
  187. The "ARMEdit" suite of software and documentation is supplied "as is"; no
  188. warranty, express or implied, of the merchantability of this software or its
  189. fitness for any particular purpose is given. In no circumstances shall the
  190. author, or any provider or distributor of this software, be liable for any
  191. damage, loss of profits, or any indirect or consequential loss arising out of
  192. the use of this software or inability to use this software.
  193.  
  194. This software is FreeWare. Permission is granted for anyone to distribute it
  195. unchanged and in its entirety, providing that no profit is made in the
  196. process. The "ARMEdit" suite may not be distributed if modified or
  197. incomplete; neither may it be distributed without this documentation.
  198. However, the "Banner" application and "Ensure" utility may be used and
  199. distributed independently providing the terms in the relevant documentation
  200. file are complied with.
  201.  
  202. To use this suite, or any part of it, as part of a system or other
  203. application that is for sale (for however much and for whatever reasons) or
  204. released as copyright material then the author's express permission in
  205. writing must be obtained. The author maintains copyright on all the material
  206. supplied and reserves the right to change these conditions at any time
  207. without notice.
  208.  
  209.  
  210. ACKNOWLEDGEMENTS
  211.  
  212. I would like to the thank the following people for their contributions to
  213. the development of this softw