From 0205eb6a2d8b54b5b77c5e8fd0dd9cd978b657bd Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 16 Jun 2014 10:39:27 -0700 Subject: [PATCH] README.md: Copy the docstring into a README And add Markdown links for all the packages we reference. This gives folks hitting the repository a more traditional welcome. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..048bf94 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +Software Carpentry Windows Installer + +Helps mimic a *nix environment on Windows with as little work as possible. + +The script: + +* Installs [nano][] and makes it accessible from [msysGit][] +* Installs [SQLite][] and makes it accessible from msysGit +* Creates a `~/nano.rc` with links to syntax highlighting configs +* Provides standard [nosetests][] behavior for msysGit +* Add [R][]'s bin directory to the path (if we can find it) + +To use: + +1. Install [Python][], [IPython][], and [Nose][nose]. An easy way to + do this is with the [Anaconda CE][Anaconda-CE] Python distribution. +2. [Install msysGit][msysgit-install] +3. Run `swc-windows-installer.py`. You should be able to simply + double click the file in Windows. + +[msysGit]: http://msysgit.github.io/ +[msysgit-install]: https://github.com/msysgit/msysgit/releases +[nano]: http://www.nano-editor.org/ +[SQLite]: http://www.sqlite.org/ +[Python]: https://www.python.org/ +[IPython]: http://ipython.org/ +[Nose]: https://nose.readthedocs.org/en/latest/ +[nosetests]: https://nose.readthedocs.org/en/latest/usage.html +[R]: http://www.r-project.org/ +[Anaconda-CE]: http://continuum.io/anacondace.html -- 2.26.2