README.md: Link to GitHub releases for the most-recent compiled version
[swc-setup-windows-installer.git] / README.md
1 Software Carpentry Windows Installer
2
3 Helps mimic a *nix environment on Windows with as little work as possible.
4
5 The script:
6
7 * Installs [nano][] and makes it accessible from [msysGit][]
8 * Installs [SQLite][] and makes it accessible from msysGit
9 * Creates a `~/nano.rc` with links to syntax highlighting configs
10 * Provides standard [nosetests][] behavior for msysGit
11 * Adds [R][]'s bin directory to the path (if we can find it)
12
13 Building
14 ========
15
16 Building the Windows installer requires a Windows machine with Python,
17 [py2exe][] and [Inno Setup][inno]. `py2exe` can be installed using `pip` and
18 Inno Setup can be installed using the self-installing package from
19 [the download page][inno-download].
20
21 ```
22 python setup.py install
23 python setup.py py2exe
24 ISCC.exe swc-installer.iss
25 ```
26
27 For folks who don't want to build their own version, the most recent
28 version is also [available here][compiled].
29
30 Using
31 =====
32
33 Just have your students download and double-click the compiled
34 installer.
35
36 [msysGit]: http://msysgit.github.io/
37 [nano]: http://www.nano-editor.org/
38 [SQLite]: http://www.sqlite.org/
39 [nosetests]: https://nose.readthedocs.org/en/latest/usage.html
40 [R]: http://www.r-project.org/
41 [py2exe]: http://py2exe.org/
42 [inno]: http://www.jrsoftware.org/isinfo.php
43 [inno-download]: http://www.jrsoftware.org/isdl.php
44 [compiled]: https://github.com/swcarpentry/windows-installer/releases/latest