From fdc8bbff99f4318333e27f3a1efb04dc28794901 Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Mon, 19 Mar 2012 19:48:41 -0700
Subject: [PATCH] Add some documentation about Windows support.

Summary: Docs.

Test Plan: Read.

Reviewers: Makinde, btrahan

Reviewed By: Makinde

CC: aran, epriestley

Maniphest Tasks: T124

Differential Revision: https://secure.phabricator.com/D1940
---
 src/docs/installation_guide.diviner         |  3 ++
 src/docs/userguide/arcanist_windows.diviner | 38 +++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 src/docs/userguide/arcanist_windows.diviner

diff --git a/src/docs/installation_guide.diviner b/src/docs/installation_guide.diviner
index 304d2f7fbd..563af05654 100644
--- a/src/docs/installation_guide.diviner
+++ b/src/docs/installation_guide.diviner
@@ -19,6 +19,9 @@ Phabricator is a LAMP application suite, so you basically need LAMP:
   - **MySQL**: You need MySQL.
   - **PHP**: You need PHP 5.2 or newer.
 
+NOTE: The command line interface to Phabricator, "Arcanist", //does// work on
+Windows. For instructions, see @{article:Arcanist User Guide: Windows}.
+
 You'll probably also need a **domain name** and you'll certainly need
 **a computer** with a connection to **the internet**.
 
diff --git a/src/docs/userguide/arcanist_windows.diviner b/src/docs/userguide/arcanist_windows.diviner
new file mode 100644
index 0000000000..35a9e3570c
--- /dev/null
+++ b/src/docs/userguide/arcanist_windows.diviner
@@ -0,0 +1,38 @@
+@title Arcanist User Guide: Windows
+@group userguide
+
+Explains how to install Arcanist on Windows.
+
+= Overview =
+
+Arcanist runs on Windows, either in `cmd.exe` or the Git Bash environments.
+However, it will take a little effort to get working. This document explains
+what you need to do in order to get it running.
+
+NOTE: Windows support is relatively new and incomplete, file bugs when you run
+into issues.
+
+= Required Components =
+
+You need to install:
+
+  - Arcanist itself, see @{article:Arcanist User Guide}.
+  - PHP
+  - SVN, Git, or Mercurial.
+
+Then, configure:
+
+  - Your PATH environmental variable should include `arcanist/bin`, the `php`
+    directory, and the directory where your VCS command lives. When you type
+    `php`, `arc`, or (for example) `git` from the command line, they should all
+    do something.
+  - Your EDITOR environmental variable should point at some valid CLI editor,
+    like the Git Bash `vim`. (Under `cmd.exe`, you need to point to the actual
+    `vim.exe`, not just the `bin/vim` symlink which runs it under Git Bash
+    since `cmd.exe` does not know how to run the symlink.)
+
+You can set environmental variables somewhere in the `Advanced` tab of the
+`System` control panel.
+
+Now you should be able to run `arc` normally (either from `cmd.exe` or
+Git Bash) and it should work more-or-less properly.