home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsa / armedit / ReadMe < prev   
Text File  |  1996-01-12  |  7KB  |  191 lines
  1. File        : ReadMe
  2. Date        : 12-Jan-96
  3. Author      : © A.Thoukydides, 1995, 1996
  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 (that must be loaded before starting the PC card
  11. front-end) and a number of DOS executables.
  12.  
  13. This is an early release of the software with only a fraction of the intended
  14. functionality. This is to enable the current utilities to be useful before
  15. the full release is available. Some of the other components under development
  16. are:
  17.  
  18.     A DOS command ARMEDIT which will allow PC files to be edited in a RISC OS
  19.     editor using the External Data Editing Protocol (supported by both Zap
  20.     and StrongEd).
  21.     
  22.     Enhanced versions of the existing utilities, e.g. an OSCLI command that
  23.     ties both input and output streams to those of the DOS command.
  24.     
  25.     A DOS device driver to allow RISC OS filesystems to be accessed like the
  26.     normal PC partition. This may be restricted to read only.
  27.  
  28. Note that the message passing support is currently experimental - it has not
  29. been thoroughly tested, and the way in which it operates may change in a
  30. later version of the ARMEdit module.
  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.     ARMEdit             A RISC OS module that provides support for the other
  40.                         utilities. It must be loaded before starting the PC
  41.                         front-end.
  42.  
  43.     Code                Header files and object files required for developing
  44.         ARMFILE/H       extra PC side utilities. See Docs.Code for more
  45.         ARMFILE/OBJ     details of how to use these.
  46.         HPC/OBJ
  47.         SWI/H
  48.         SWI/OBJ
  49.         TALK/H
  50.         TALK/OBJ
  51.  
  52.     Docs                The rest of the documentation. The different files
  53.         Code            are described below. Read these before reporting any
  54.         GETFILE         problems.
  55.         Module
  56.         OSCLI
  57.         PUTFILE
  58.         
  59.     PC                  The PC executables. These should be copied directly
  60.         GETFILE/COM     from the archive to a PC partition, otherwise the
  61.         OSCLI/COM       filenames are likely to get truncated.
  62.         PUTFILE/COM
  63.  
  64.     ReadMe              This file.
  65.         
  66.  
  67. QUICK START
  68.  
  69. Before starting it is worth noting that this software requires a version of
  70. the PC front-end software 1.87 or above. The version number is displayed in
  71. the Info window from the icon-bar icon. Upgrades are available from both
  72. Acorn's (ftp.acorn.co.uk) and Aleph One's (ftp.ant.co.uk) ftp sites.
  73.  
  74. To try these programs quickly follow these simple instructions:
  75.  
  76.     Copy the files from the PC directory of the archive into your PC
  77.     partition. If you are unsure of how to do this then read the relevant
  78.     sections of the manuals that came with the computer and PC card.
  79.  
  80.     Load the ARMEdit module (double-click on its icon in a filer window)
  81.     before starting the PC software.
  82.     
  83.     Start the PC front-end software.
  84.  
  85.     If you are not at a DOS prompt then obtain one, e.g. from Windows
  86.     double-click on the MS-DOS Prompt icon.
  87.     
  88.     Change to the directory containing the files copied from the PC directory
  89.     of the archive.
  90.     
  91.     Type "OSCLI Help ARMEdit". This should display some familiar looking
  92.     help text.
  93.     
  94.     For information about each of the commands simply append /? after the
  95.     command name, e.g. "PUTFILE /?".
  96.  
  97. To find out more read the documentation files listed below.
  98.  
  99.  
  100. DOCUMENTATION
  101.  
  102. For more information on this set of utilities please refer to the documents
  103. in the "Docs" sub-directory. The files are:
  104.  
  105.     Code        - Documentation required for writing extra utilities for use
  106.                   with the ARMEdit module.
  107.                   
  108.     GETFILE     - Documentation for the "GETFILE" PC executable which allows
  109.                   files to be copied from RISC OS to DOS.
  110.     
  111.     Module      - Documentation for the "ARMEdit" module which provides vital
  112.                   support for all parts of the system.
  113.     
  114.     OSCLI       - Documentation for the "OSCLI" PC executable which allows
  115.                   RISC OS *commands to be executed from DOS.
  116.     
  117.     PUTFILE     - Documentation for the "PUTFILE" PC executable which allows
  118.                   files to be copied from DOS to RISC OS.
  119.  
  120.  
  121. LEGAL MATTERS
  122.  
  123. The "ARMEdit" suite of software and documentation is supplied "as is"; no
  124. warranty, express or implied, of the merchantability of this software or its
  125. fitness for any particular purpose is given. In no circumstances shall the
  126. author, or any provider or distributor of this software, be liable for any
  127. damage, loss of profits, or any indirect or consequential loss arising out of
  128. the use of this software or inability to use this software.
  129.  
  130. This software is FreeWare. Permission is granted for anyone to distribute it
  131. unchanged and in its entirety, providing that no profit is made in the
  132. process. The "ARMEdit" suite may not be distributed if modified or
  133. incomplete; neither may it be distributed without this documentation.
  134.  
  135. To use this suite, or any part of it, as part of a system or other
  136. application that is for sale (for however much and for whatever reasons) or
  137. released as copyright material then the author's express permission in
  138. writing must be obtained. The author maintains copyright on all the material
  139. supplied and reserves the right to change these conditions at any time
  140. without notice.
  141.  
  142.  
  143. CONTACTING THE AUTHOR
  144.  
  145. I would be interested in hearing of any bugs or other unexpected features in
  146. this suite of software, and will endeavour to correct any such problems in
  147. future releases. Suggestions for improvements are also most welcome.
  148. Implementation depends upon practicability and on how much spare time I have.
  149.  
  150. If you have any comments on this program, or would like to suggest ways in
  151. which it could be improved, I can be contacted at one of the following
  152. addresses:
  153.     
  154.     Thalna
  155.     2 Dukes Drive
  156.     Bearwood
  157.     Bournemouth
  158.     Dorset
  159.     BH11 9SZ
  160.     
  161.     thouky@tcp.co.uk
  162.  
  163. If in any communication you make specific reference to the program code please:
  164.  
  165.     Quote the version number and date of both the ARMEdit module and the
  166.     component concerned.
  167.     
  168.     Refer only to the software as released.
  169.     
  170.     Supply as many details as possible about the problem, including the
  171.     hardware and software configuration of the machine being used.
  172.  
  173. Please send a stamped and self addressed envelope, or give details of how to
  174. contact via e-mail, if you would like a reply.
  175.  
  176. I hope you find this software of some use.
  177.  
  178.  
  179. ACKNOWLEDGEMENTS
  180.  
  181. I would like to the thank the following people for their contributions to
  182. the development of this software:
  183.  
  184.     Acorn Computers - The Risc PC, RISC OS and the ObjAsm assembler.
  185.     Aleph One       - Producing the PC cards and supplying the required info.
  186.     Ray Dawson      - Suggestion for improvements to early versions.
  187.     Mike Hobbs      - Useful comments during early development and testing.
  188.     Dominic Symes   - The brilliant !Zap editor; get a copy immediately.
  189.     Robin Watts     - !Larger, the greatest backdrop program ever.
  190.     Mark Wooding    - !Glass, the best template editor.
  191.