chiark - git - mdw - ssr/blob - dist/README

   1 STRAYLIGHT SOURCE RELEASE
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~
   3
   4 This directory contains the Straylight Source Release.  The various Zip
   5 files contain sources to distinct pieces of software.  Unfortunately,
   6 the code was never written to be distributed, so there's a complex
   7 pattern of interdependency between some of the packages.
   8
   9 `Phase 1' of the Release consists of the following parts:
  10
  11 Core            Contains standard libraries and build tools required for
  12                 building everything else.
  13
  14 Dynamite        Straylight's dynamic area management module.  Requires
  15                 Core.
  16
  17 MiscToys        Some fairly silly utilities.  Requires Core.
  18
  19 Sapphire        A large library for writing applications in ARM
  20                 assembler.  There's a `README' file providing a brief
  21                 overview, documented header files and a few examples.
  22                 Requires Core, SDLS, and Sculptrix
  23
  24 Sculptrix       A module for drawing 3D buttons.  Requires Sapphire for
  25                 the configuration program.
  26
  27 SDLS            Straylight's dynamic linking system.  Requires Sculptrix.
  28
  29 Phase 2 will contain some more toys, the Steel C library, and the Glass
  30 template editor.  I'm not making any promises with regard to release
  31 times for phase 2.
  32
  33 Building the SSR should be fairly straightforward.  First, unpack the
  34 sections you want.  They all share the same build root directory
  35 `StraySrc'.
  36
  37 Now, make sure that the environment is set up properly.  I tested the
  38 Release using a minimal toolset consisting of:
  39
  40   * The following programs available in Run$Path:
  41
  42     amu         Acorn's Make Utility version 5.02
  43     cc          The Acorn C compiler version 5.06
  44     ccrunch     A BASIC compactor written by Ragnar Hafstað
  45     libfile     Acorn's library management tool version 5.00
  46     link        Acorn's linker version 5.06
  47     o-cc        An old Acorn C compiler version 4.00
  48     o-libfile   An old Acorn library management tool version 4.00
  49     o-link      An old Acorn linker version 4.00
  50     o-objasm    An old Acorn assembler version 2.00
  51     objasm      Acorn's ARM assembler version 3.06
  52     sed         GNU sed version 2.03
  53     squeeze     Acorn's AIF squeezer version 5.00
  54     unzip       InfoZIP unarchiver version 5.13c BETA
  55     zip         InfoZIP archiver version 2.0j
  56
  57   * The following libraries available in C$Path:
  58
  59     clib        Acorn's C library headers
  60     risc_oslib  Acorn's RISC OS library headers and object files
  61
  62 You may be able to get away with different versions of tools.  In
  63 particular, the old versions of Acorn's tools are used to ensure
  64 that AOF2 is generated for compatibility with other people's old tools.
  65
  66 SSR requires its own tools and libraries in addition to those listed
  67 above.  It will create `Libs$Path' pointing at its own libraries, and
  68 add its own tools to `Run$Path' when you run `ssr-init'.
  69
  70 To build everything, run
  71
  72   amu
  73   amu install
  74
  75 in the `StraySrc' directory.  This will recursively build and install
  76 everything you've unpacked.  (The Makefiles work out which bits you've
  77 got and build them.)  If this doesn't work, make sure you've got all
  78 the tools you need, and all the paths are set up right.
  79
  80 All the source code may be modified and redistributed under the terms of
  81 the GNU General Public License, which is included in the distribution
  82 archives as `StraySrc.COPYING'.  Special exceptions for distribution of
  83 binaries may be given; please ask me for permission.
  84
  85 Public discussion of the Straylight Source Release, including reporting
  86 of bugs, and requesting new features, will take place on a mailing list.
  87 To subscribe, send mail to `ssr-subscribe@excessus.demon.co.uk'.  You
  88 will be asked to send a confirmation message to prove that you can
  89 receive mail from the list.  To send a message to the list, mail
  90 `ssr@excessus.demon.co.uk'.
  91
  92 I want to gather a small team of developers to continue maintenance of
  93 SSR.  If you think you could help to maintain and develop parts of SSR,
  94 or write documentation for it, then send me email.
  95
  96
  97 My personal email address is mdw@excessus.demon.co.uk.  Please try to
  98 report problems or requests to the list.  (On the other hand, problems
  99 /about/ the list probably ought to be sent to me!)
 100
 101 I think that about wraps it up for me.
 102
 103                                                 Mark Wooding
 104                                                 Fri 30th January 1998