Updated the guide and faq regarding cygwin.

sedwards2009 · Mar 20, 2016 · dd00710 · dd00710
1 parent 825db0e
commit dd00710
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/docs/faq.md b/docs/faq.md
@@ -1,8 +1,25 @@
 FAQ
 ===
 
+
 Extraterm won't start on my cygwin
 ----------------------------------
+
+### Make sure Python 3 is installed
+
+Extraterm requires Python 3 to be installed in cygwin or Babun to run.
+
+If you are using plain cygwin you can install `python3` via the installer.
+
+If you are Babun you can install Python 3 from a shell using:
+
+```
+pact install python3
+```
+
+
+### Problems finding the cygwin installation directory
+
 Extraterm tries to find the location of your cygwin installation directory by looking in the Windows registry. If it fails to find anything there then it will look in the default Babun installation directory. If that too fails then Extraterm will fail to start up with an error like: "TypeError: Cannot read property 'cygwinDir' of null".
 
 To explicitly specify where your cygwin installation directory is you can pass the `--cygwinDir` option to Extraterm when starting it up:

diff --git a/docs/guide.md b/docs/guide.md
@@ -8,9 +8,15 @@ Installation
 ------------
 Extraterm support Linux, Mac OS X and Cygwin on Windows. Download the zip file for your operating system on the [github releases page](https://github.com/sedwards2009/extraterm/releases).
 
-Unzip the file somewhere convenient. Start Extraterm by running the `extraterm` or `extraterm.exe` file inside the unzip directory. OS X users can just start the application via the Finder. If you have trouble starting Extraterm on cygwin see the [FAQ](faq.md).
+Unzip the file somewhere convenient.
 
-Extraterm doesn't need any other installation.
+Start Extraterm:
+
+* **Linux** - Run the `extraterm` file inside the unzip directory.
+* **Mac OS X** - Just start the application via the Finder.
+* **Cygwin and Babun** - Double click to run the Extraterm application inside the unzip directory, or using the shell, execute the `extraterm` file inside the unzip directory. Note you must have Python 3 installed inside cygwin for Extraterm to run (see the [FAQ](faq.md) ). If you have trouble starting Extraterm on cygwin also consult the [FAQ](faq.md).
+
+Extraterm doesn't need any further installation.
 
 
 Basics