Bump the version number in configure.ac to 1.0.5
[moonshot-ui.git] / README.windows
index d984f35..86cd636 100644 (file)
@@ -6,18 +6,21 @@ I recommend you set up a build environment according to the following page:
   http://afuera.me.uk/jhbuild-windows/
 
 However, use the configuration file in the source tree at ./windows/jhbuildrc
-instead of creating a new one. You can tell jhbuild to use that file by running
+instead of creating a new one. This means that the last two commands you execute
+become (from inside the moonshot-ui source tree):
 
-  jhbuild -f jhbuildrc <...>
+  jhbuild -f ./windows/jhbuildrc bootstrap
+  jhbuild -f ./windows/jhbuildrc
 
-You will also need to install the following extras:
+
+You will also need to install the following tools:
 
   * MS Windows Platform SDK v7.0 and .NET framework 3.5:
 
       https://www.microsoft.com/downloads/en/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en
 
-    You need the 'Win32 Developer Tools' component for MIDL.EXE, the rest are
-    not important.
+    You need the 'Win32 Developer Tools' component for MIDL.EXE, and 'Visual C compilers'
+    to LIB.EXE. The rest are not important.
 
   * Windows Installer XML 3.5:
 
@@ -25,13 +28,13 @@ You will also need to install the following extras:
 
   * ImageMagick (for converting .svg icons to .png in 'make icons'):
 
-     http://www.imagemagick.org/download/binaries/ImageMagick-6.6.9-10-Q16-windows-dll.exe
+     http://www.imagemagick.org/download/binaries/ImageMagick-6.7.3-7-Q16-windows-dll.exe
 
-I suggest you put all these things in their default locationsthe installers
-seem to mostly ignore attempts to install them in other places.
+I suggest you put all these things in their default locations (the installers
+will sometimes ignore attempts to install them in other places).
 
 You currently also need a patched version of the w32api mingw package, to
-expose some RPC functions. This is on the mingw issue tracker here:
+expose some RPC functions. This issue is on the mingw issue tracker here:
 
   https://sourceforge.net/tracker/?func=detail&aid=3302807&group_id=2435&atid=302435
 
@@ -43,16 +46,39 @@ extract into c:\tools\mingw:
 (Alternately you can fetch the source for the w32api package from
  www.sourceforge.net/projects/mingw and apply the patch yourself)
 
-You will need to compile and install the msrpc-mingw package.
 
-You can then build moonshot from the MSYS shell:
+You will need to compile and install the msrpc-mingw package, which wraps
+MIDL.EXE and the RPC API to make it usable from gcc.
+
+  git clone git://github.com/ssssam/msrpc-mingw.git
+  cd msrpc-mingw
+  MIDL=/c/Program\ Files/Microsoft SDKs/Windows/v7.0/bin/MIDL.exe ./waf configure --prefix=c:/build
+  ./waf
+  ./waf install
+
+You can then configure moonshot from the MSYS shell:
+
+  ACLOCAL="aclocal -I/c/build/share/aclocal" PKG_CONFIG_PATH=/c/build/lib/pkgconfig \
+    ./autogen.sh --disable-maintainer-mode --prefix=/c/build
+
+The configure script looks for various tools that it may not be able to locate
+automatically. In these cases you will get an error message, and you can set the
+environment variable described there to the location of the program. For example,
+if LIB.EXE is not found you will need to run
 
   ACLOCAL="aclocal -I/c/build/share/aclocal" PKG_CONFIG_PATH=/c/build/lib/pkgconfig \
-  ./autogen.sh --prefix=/c/build --disable-maintainer-mode
+    MSVC_LIB="/c/Program Files/...VC location../bin/lib.exe" \
+    ./autogen.sh --disable-maintainer-mode
+
+If this succeeds, you're ready to build!
+
   make
   make icons
   make installer
 
+The icons and installer targets make a few assumptions based on the install
+prefix. You may have to edit Makefile.am to edit the paths if you haven't
+followed the instructions exactly.
 
 Weird things that might go wrong
 --------------------------------
@@ -60,11 +86,13 @@ Weird things that might go wrong
 MSYS is a little fragile, here are some things to try if you get weird failures
 of any component:
 
-# Make sure your PATH looks like this:
-#   /c/build/bin:/c/tools/python:/usr/local/bin:/mingw/bin:/bin
-# so that there are no entries before these that might override a shell tool.
+  * Make sure your PATH looks like this:
+      /c/build/bin:/c/tools/python:/usr/local/bin:/mingw/bin:/bin
+    so that there are no entries before these that might override a shell tool.
 
-# Sometimes TMP is set and this breaks some of the tools
-export TMP=
+  * Sometimes TMP is set and this breaks some of the tools. Run:
+      export TMP=
+    to fix this.
 
-# Make
+  * Don't ever use \ in paths (except to escape spaces) - always use /c/build/bin
+    not c:\build\bin. Otherwise shell scripts break all over the place.