Merge pull request #21 from wking/make
[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 To use:
14
15 1. Install [Python][], [IPython][], and [Nose][nose].  An easy way to
16    do this is with the [Anaconda][] Python distribution.
17 2. [Install msysGit][msysgit-install]
18 3. [Install R][R-install] (if your workshop uses R).
19 4. Run `swc-windows-installer.py`.  You should be able to simply
20    double click the file in Windows.
21
22 [msysGit]: http://msysgit.github.io/
23 [msysgit-install]: https://github.com/msysgit/msysgit/releases
24 [nano]: http://www.nano-editor.org/
25 [SQLite]: http://www.sqlite.org/
26 [Python]: https://www.python.org/
27 [IPython]: http://ipython.org/
28 [Nose]: https://nose.readthedocs.org/en/latest/
29 [nosetests]: https://nose.readthedocs.org/en/latest/usage.html
30 [R]: http://www.r-project.org/
31 [R-install]: http://cran.r-project.org/bin/windows/base/rw-FAQ.html#Installation-and-Usage
32 [Anaconda]: http://continuum.io/downloads