doc/Installing SoccerFun on Windows.txt

   1 To install SoccerFun on a Windows machine:
   2
   3 (1) You need a Clean 2.3 distribution. You can download this for
   4     free at:
   5
   6         http://wiki.clean.cs.ru.nl/Clean
   7
   8 (2) Unpack the Clean 2.3 distribution.
   9
  10 (3) In the Clean 2.3 distribution you find the CleanIDE.exe and a number
  11     of directories: Config, Examples, Help, Libraries, Temp, and Tools.
  12
  13     Move the unpacked SoccerFun distribution to Examples.
  14
  15     After this action the Examples folder of your Clean distribution should
  16     contain a SoccerFun folder with the following content:
  17
  18     Examples\
  19         ...
  20         SoccerFun\
  21             doc\
  22                 quickstart_SoccerFun\
  23                     quickstart_SoccerFun.pdf
  24                 Installing SoccerFun on Windows.txt  // the document you're reading right now
  25             src\
  26                 afbeeldingen\
  27                 Game\
  28                 Gui\
  29                 sound\
  30                 StdLibExt\
  31                 StdReferee\
  32                 StdTeam\
  33                 SoccerFun.env                        // see step 5 below
  34                 SoccerFun64.env                      // see step 5 below
  35                 SoccerFun.icl
  36                 SoccerFun.prj                        // see step 6 below
  37
  38
  39 (4) Run the CleanIDE. If it is the first time that you run it, it will ask you
  40     if it can integrate itself in the Windows system.
  41     Choose "Yes" if you want this, "No" if you want to defer.
  42     Note: choose "Never" only if you are very certain about this,
  43           because it means truely never.
  44
  45 (5) In the CleanIDE choose the command "Environment:Import...".
  46     On a 32bit Windows machine, direct the file selector dialog to
  47        SoccerFun\src\SoccerFun.env
  48     and import the environment.
  49     On a 64bit Windows machine, direct the file selector dialog to
  50        SoccerFun\src\SoccerFun64.env
  51     and import the environment.
  52
  53     This will set the default paths for the compiler.
  54
  55     You need to do this only once for your Clean distribution.
  56
  57     This step was successful if the CleanIDE has added "SoccerFun" to its list of
  58     environments (command "Environment").
  59
  60 (6) Now you can open (command "File:Open...") the project file at
  61     Examples\SoccerFun\src\SoccerFun.prj.
  62
  63 (7) Make sure the Environment of the CleanIDE is set to "SoccerFun".
  64     Do this with the command "Environment:SoccerFun".
  65
  66 (8) Bring the project up to date with "Project:Bring Up To Date".
  67     Now all modules are compiled and an executable is created.
  68     The executable can be launched with "Project:Run".
  69
  70     Note that "Project:Update and Run" combines the latter commands.
  71
  72 (9) If all went well, Soccer-Fun should have started. Have fun!