diff --git a/src/docs/user/userguide/arcanist_mac_os_x.diviner b/src/docs/user/userguide/arcanist_mac_os_x.diviner index a34adfbf5d..d75df8b33b 100644 --- a/src/docs/user/userguide/arcanist_mac_os_x.diviner +++ b/src/docs/user/userguide/arcanist_mac_os_x.diviner @@ -1,31 +1,32 @@ @title Arcanist User Guide: Mac OS X @group userguide Explains how to install Arcanist on Mac OS X. = Required Components = You need to install: - PHP, which should be installed by default. - Arcanist itself, see @{article:Arcanist User Guide}. + or @{article:Arcanist Quick Start} - SVN, Git, or Mercurial. Then, configure: - Your PATH environmental variable should include `arcanist/bin`, and `php` and your VCS command (`svn`, `hg`, `git`) should be in PATH. 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 `nano`, which is the best editor. You can edit your `~/.profile` to permanently configure environmental variables. Now you should be able to run `arc` like a normal command. = Next Steps = Continue by: - returning to @{article:Arcanist User Guide}. diff --git a/src/docs/user/userguide/arcanist_quick_start.diviner b/src/docs/user/userguide/arcanist_quick_start.diviner index 98633bfaef..743afe4a11 100644 --- a/src/docs/user/userguide/arcanist_quick_start.diviner +++ b/src/docs/user/userguide/arcanist_quick_start.diviner @@ -1,83 +1,82 @@ @title Arcanist Quick Start @group userguide Quick guide to getting Arcanist working for a new project. This is a summary of steps to install Arcanist, configure a project for use with -it, and run `arc` to send changes for review. - -= Install Arcanist = - -For detailed instructions on installing Arcanist, see -@{article:Arcanist User Guide}. +it, and run `arc` to send changes for review. For detailed instructions on +installing Arcanist, see @{article:Arcanist User Guide}. OS specific guides +are also available. - For Mac OS X, see @{article:Arcanist User Guide: Mac OS X}. - For Windows, see @{article:Arcanist User Guide: Windows}. += Installing Arcanist = + First, install dependencies: - Install PHP. - Install Git. Then install Arcanist itself: $ mkdir somewhere/ $ cd somewhere/ somewhere/ $ git clone https://github.com/phacility/libphutil.git somewhere/ $ git clone https://github.com/phacility/arcanist.git Add `arc` to your path: $ export PATH="$PATH:/somewhere/arcanist/bin/" This won't work for Windows, see @{article:Arcanist User Guide: Windows} for instructions. = Configure Your Project = For detailed instructions on project configuration, see @{article:Arcanist User Guide: Configuring a New Project}. Create a `.arcconfig` file in your project's working copy: $ cd yourproject/ yourproject/ $ $EDITOR .arcconfig yourproject/ $ cat .arcconfig { "phabricator.uri" : "https://phabricator.example.com/" } Set `phabricator.uri` to the URI for your Phabricator install (where `arc` should send changes to). NOTE: You should **commit this file** to the repository. = Install Arcanist Credentials = Credentials allow you to authenticate. You must have an account on Phabricator before you can perform this step. $ cd yourproject/ yourproject/ $ arc install-certificate ... Follow the instructions. This will link your user account on your local machine to your Phabricator account. = Send Changes For Review = For detailed instructions on using `arc diff`, see @{article:Arcanist User Guide: arc diff}. $ $EDITOR file.c $ arc diff = Next Steps = Continue by: - learning more about project configuration with @{article:Arcanist User Guide: Configuring a New Project}; or - learning more about `arc diff` with @{article:Arcanist User Guide: arc diff}; or - returning to @{article:Arcanist User Guide}. diff --git a/src/docs/user/userguide/arcanist_windows.diviner b/src/docs/user/userguide/arcanist_windows.diviner index 150e4f3372..56fbfea318 100644 --- a/src/docs/user/userguide/arcanist_windows.diviner +++ b/src/docs/user/userguide/arcanist_windows.diviner @@ -1,108 +1,109 @@ @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}. + or @{article:Arcanist Quick Start}. - PHP (see "Detailed PHP Install Instructions" below). - 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`. You can set this in `arc` if you prefer. See below for details. 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. = Configuring an Editor = NOTE: You **can not** use Notepad as your editor, because it does not have a blocking mode. You can use GitPad instead. Some arc workflows prompt you to edit large blocks of text using a text editor. You can configure various programs for this purpose, depending on which text editor you prefer. Some editors that will work are: - [[ http://notepad-plus-plus.org/ | Notepad++ ]], a good all-around editor. - **vim**, which comes with Git Bash. - [[ https://github.com/github/gitpad | GitPad ]], which allows you to use Notepad as your editor. Other editors may also work, but they must have a blocking edit mode. To configure an editor, either set the `EDITOR` environmental variable to point at it, or run: $ arc set-config editor "\"C:\path\to\some\editor.exe\"" NOTE: Note the use of quotes. Paths with spaces in them must be quoted, and these quotes must be escaped when passed to `arc set-config`, as in the examples below. Specifically, you can use this command for **Notepad++** (adjusting the path for your machine): name=Notepad++ $ arc set-config editor "\"C:\Program Files (x86)\Notepad++\notepad++.exe\" -multiInst -nosession" And this command for Vim (you may need to adjust the path): name=vim $ arc set-config editor "\"C:\Program Files (x86)\Git\share\vim\vim73\vim.exe\"" And this for GitPad (you may need to adjust the path): name=GitPad $ arc set-config editor "\"C:\Users\yourusername\AppData\Roaming\GitPad\GitPad.exe\"" And this for Sublime Text (you may need to adjust the path): name=Sublime Text $ arc set-config editor "\"C:\Program Files\Sublime Text 2\sublime_text.exe\" -w -n" = Detailed PHP Install Instructions = While multiple versions of PHP should work, you can follow these specific instructions if you're having trouble. - Download the latest stable PHP binary release from: . When this document was last updated, this was PHP 5.4.6, but newer versions should also work. The "VC9 x86 Non Thread Safe" build should work correctly. (Other versions newer than PHP 5.3 should work, and thread-safe versions should also work.) - Unzip the PHP directory. - Copy `php.ini-development` to `php.ini` in that same directory. - Open `php.ini` and locate the line `;extension=php_curl.dll`. Remove the `;` to activate this extension. Locate the line `; extension_dir = "ext"` and change it to `extension_dir = "C:\PHP\ext"`, where `C:\PHP` is the directory where you installed PHP. - Verify that things work by running `php -i` from your commandline and looking for `curl` in the output. = Next Steps = Continue by: - returning to @{article:Arcanist User Guide}.