initial framework added

[fp1415-soccerfun.git] / doc / Installing SoccerFun on Windows.txt

diff --git a/doc/Installing SoccerFun on Windows.txt b/doc/Installing SoccerFun on Windows.txt
new file mode 100644 (file)
index 0000000..2eab777
--- /dev/null
+++ b/doc/Installing SoccerFun on Windows.txt
@@ -0,0 +1,72 @@
+To install SoccerFun on a Windows machine:\r
+\r
+(1) You need a Clean 2.3 distribution. You can download this for \r
+    free at:\r
+\r
+        http://wiki.clean.cs.ru.nl/Clean\r
+\r
+(2) Unpack the Clean 2.3 distribution. \r
+\r
+(3) In the Clean 2.3 distribution you find the CleanIDE.exe and a number \r
+    of directories: Config, Examples, Help, Libraries, Temp, and Tools.\r
+    \r
+    Move the unpacked SoccerFun distribution to Examples. \r
+\r
+    After this action the Examples folder of your Clean distribution should\r
+    contain a SoccerFun folder with the following content:\r
+\r
+    Examples\\r
+        ...\r
+        SoccerFun\\r
+            doc\\r
+                quickstart_SoccerFun\\r
+                    quickstart_SoccerFun.pdf\r
+                Installing SoccerFun on Windows.txt  // the document you're reading right now\r
+            src\\r
+                afbeeldingen\\r
+                Game\\r
+                Gui\\r
+                sound\\r
+                StdLibExt\\r
+                StdReferee\\r
+                StdTeam\\r
+                SoccerFun.env                        // see step 5 below\r
+                SoccerFun64.env                      // see step 5 below\r
+                SoccerFun.icl\r
+                SoccerFun.prj                        // see step 6 below\r
+    \r
+\r
+(4) Run the CleanIDE. If it is the first time that you run it, it will ask you \r
+    if it can integrate itself in the Windows system. \r
+    Choose "Yes" if you want this, "No" if you want to defer. \r
+    Note: choose "Never" only if you are very certain about this, \r
+          because it means truely never.\r
+\r
+(5) In the CleanIDE choose the command "Environment:Import...".\r
+    On a 32bit Windows machine, direct the file selector dialog to \r
+       SoccerFun\src\SoccerFun.env \r
+    and import the environment.\r
+    On a 64bit Windows machine, direct the file selector dialog to\r
+       SoccerFun\src\SoccerFun64.env\r
+    and import the environment.\r
+\r
+    This will set the default paths for the compiler.\r
+\r
+    You need to do this only once for your Clean distribution. \r
+\r
+    This step was successful if the CleanIDE has added "SoccerFun" to its list of\r
+    environments (command "Environment").\r
+\r
+(6) Now you can open (command "File:Open...") the project file at \r
+    Examples\SoccerFun\src\SoccerFun.prj.\r
+\r
+(7) Make sure the Environment of the CleanIDE is set to "SoccerFun".\r
+    Do this with the command "Environment:SoccerFun".\r
+\r
+(8) Bring the project up to date with "Project:Bring Up To Date".\r
+    Now all modules are compiled and an executable is created.\r
+    The executable can be launched with "Project:Run".\r
+\r
+    Note that "Project:Update and Run" combines the latter commands.\r
+\r
+(9) If all went well, Soccer-Fun should have started. Have fun!\r