Merge branch 'c-agents'

[progcomp10.git] / src / link / C / WINDOWS.txt

diff --git a/src/link/C/WINDOWS.txt b/src/link/C/WINDOWS.txt
new file mode 100644 (file)
index 0000000..d167e2b
--- /dev/null
+++ b/src/link/C/WINDOWS.txt
@@ -0,0 +1,38 @@
+WINDOWS.txt: Notes towards using C under Microsoft Windows.\r
+\r
+Whilst we are committed to supporting Windows, unfortunately Windows \r
+support is not complete at this point. Whilst there is nothing in the \r
+code that is specifically incompatible with Windows, it is entirely \r
+untested, and there may be a number of tweaks that Windows users will \r
+have to make in order to compete.\r
+\r
+ = Options for Windows Users =\r
+\r
+ - Install a *nix compatibility layer, such as Cygwin or MinGW, which \r
+will allow you to develop as if on Linux. This is *by* *far* the \r
+simplest route: everything should, in theory, just work. However, it's \r
+untested.\r
+\r
+ - Attempt to use native Windows tools. If you choose to go down this \r
+path, note the following:\r
+    - agents are compiled by linking c_link together with the agent \r
+source.\r
+    - c_agents would need to be modified to use windows style paths \r
+instead of POSIX paths.\r
+    - The externAgent wrapper may need to be tweaked.\r
+\r
+Either way, be aware that the supervisor will spawn a *lot* of processes \r
+- up to 255 child processes. How Windows will cope with that, is, as \r
+mentioned before, totally untested.\r
+\r
+ = Alternatives =\r
+\r
+There are some alternatives to development in Windows that may be open \r
+to you:\r
+ - If you are a CS or Engineering student at UWA, use Mac or Linux \r
+machines in the CS labs.\r
+ - If you are a UCC member, use either our Mac or one of the Linux \r
+machines.\r
+\r
+These environments, if available to you, are preferable to development \r
+on Windows.\r