Merge pull request #1278 from lamblin/wininstaller_doc

doc/install.txt

@@ -919,24 +919,26 @@ instructions in :ref:`windows_bleeding_edge`.
 
 .. _windows_anaconda:
 
-Installation script for AnacondaCE
-##################################
+Windows installer for AnacondaCE
+################################
 
 If you installed AnacondaCE, the simplest way to install and configure
-Theano is to download and execute this :download:`installation script
-for Theano on AnacondaCE for Windows <theano_installer_for_anaconda.bat>`.
+Theano is to download and execute this `Windows installer
+for Theano on AnacondaCE for Windows
+<https://github.com/Theano/Theano-wininstaller/raw/master/bin/theano_installer_latest.msi>`__.
 
 .. note
 
-    This script was tested on Windows 7, 64-bit edition, and AnacondaCE
-    version 1.3.1. It is still experimental, please get back to us if
-    you experience trouble with it.
+    This installer was tested on Windows 7, 64-bit edition, and AnacondaCE
+    version 1.3.1. Please get back to us if you experience trouble with it.
 
-This script will:
+This installer will:
 
-- Copy MinGW runtime DLLs into ``C:\\Anaconda\\Scripts``, so they are in the ``PATH``;
+- Copy MinGW runtime DLLs into ``C:\\Anaconda\\``, so they are in the ``PATH``;
 - Call ``pip install theano``, installing the latest released version;
-- Set up a default configuration file for Theano, ``.theanorc.txt``, containing:
+- Set up a default configuration file for Theano,
+  ``theanorc_default.txt``, and set it up as your ``.theanorc.txt`` if it
+  does not exist. It contains:
 
 .. code-block:: config
 
@@ -946,6 +948,9 @@ This script will:
     [blas]
     ldflags=
 
+When uninstalling, it will call ``pip uninstall Theano``, and remove the
+compilation cache as well as ``theanorc_default.txt``.
+
 
 .. _windows_basic:
 

doc/internal/how_to_release.txt

@@ -126,6 +126,61 @@ Finally
 
 Change ``ISRELEASED`` back to ``False``.
 
+
+Generate and upload the Windows installer
+=========================================
+
+We are now able to build and distribute an MSI installer for Windows,
+assuming that Anaconda is the installed Python distribution. This
+installer is generated by `WiX`_ from an XML file, stored in the
+`Theano-wininstaller <https://github.com/Theano/Theano-wininstaller>`__
+Git repository.
+
+* Install `WiX`_ if it is not already installed.
+
+* On a Windows machine, checkout the ``Theano-wininstaller`` repository::
+
+    git checkout https://github.com/Theano/Theano-wininstaller.git
+
+* In ``Theano-wininstaller\src``, create a *new*
+  ``theano_installer_<version>.wxs`` from the previous one. We want to
+  keep a history of these files, as they contain globally unique IDs.
+
+* Change the strings and GUIDs appropriately, see `the WiX tutorial
+  <http://wix.tramontana.co.hu/tutorial/upgrades-and-modularization>`__
+  for a reference.
+
+* Compile the ``.wxs`` file following the instructions in it, it will be something like::
+
+    candle.exe theano_installer_<version>.wxs
+    light.exe -ext WixUIExtension theano_installer_<version>.wixobj
+
+  This will generate a ``theano_installer_<version>.msi`` file in ``src``.
+
+* Test it by trying to install and uninstall it. It can be done by
+  double-clicking on it, then uninstalling it from the Windows control
+  panel, or (more easily) from the command line, which also allows to
+  save the logs (use the ``*v`` modifier to increase verbosity)::
+
+    msiexec /i <file>.msi [/l[*v] install.log]
+    msiexec /x <file>.msi [/l[*v] uninstall.log]
+
+* When the test works, copy ``theano_installer_<version>.msi``
+  into ``Theano-wininstaller\bin``, overwrite
+  ``bin\theano_installer_latest.msi`` with another copy, then add the new
+  files into the Git repository, and push to master::
+
+    copy src\theano_installer_<version>.msi bin\
+    copy /y src\theano_installer_<version>.msi bin\theano_installer_latest.msi
+    git add src\theano_installer_<version>.wxs
+    git add bin\theano_installer_<version>.msi
+    git add bin\theano_installer_latest.msi
+    git commit
+    git push
+
+.. _WiX: http://wixtoolset.org/
+
+
 Announce the release
 ====================