mirror of
https://we.phorge.it/source/phorge.git
synced 2025-01-23 21:18:19 +01:00
536b0867de
Summary: Ref T988. I'm splitting the Phabricator documentation into two separate documentation books, one less technical and one more technical. Move all the `.diviner` article files around into `src/docs/user/` or `src/docs/tech/`, accordingly. The only actual changes here are a couple of config changes in the `.book` files. Test Plan: Regenerated user and technical documentation and saw stuff in the right places. Reviewers: btrahan Reviewed By: btrahan CC: chad, aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6822
86 lines
2.2 KiB
Text
86 lines
2.2 KiB
Text
@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}.
|
|
|
|
- For Mac OS X, see @{article:Arcanist User Guide: Mac OS X}.
|
|
- For Windows, see @{article:Arcanist User Guide: Windows}.
|
|
|
|
First, install dependencies:
|
|
|
|
- Install PHP.
|
|
- Install Git.
|
|
|
|
Then install Arcanist itself:
|
|
|
|
$ mkdir somewhere/
|
|
$ cd somewhere/
|
|
somewhere/ $ git clone git://github.com/facebook/libphutil.git
|
|
somewhere/ $ git clone git://github.com/facebook/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
|
|
{
|
|
"project_id" : "yourprojectname",
|
|
"conduit_uri" : "https://phabricator.example.com/"
|
|
}
|
|
|
|
Set `project_id` to a string that identifies the project.
|
|
|
|
Set `conduit_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}.
|