summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2017-02-17 09:53:09 -0300
committerThibault Saunier <thibault.saunier@osg.samsung.com>2017-02-17 16:20:11 -0300
commitdcc28348e9d25a21e0f980a1cbb66f5397da98c6 (patch)
tree9597cda81c837c7c840b4954ff6624d358a570c0
parent166ba8eabe9e5963b59c77ea7d32bc17af2e91b5 (diff)
README: Add some documentation about how to first setup a project
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Differential Revision: https://phabricator.freedesktop.org/D1673
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index a50b4bc..a0b0898 100644
--- a/README.md
+++ b/README.md
@@ -130,3 +130,13 @@ You can now cleanup your branches:
Task 'T3436' has been closed, do you want to delete branch 'xclaesse/wip/phab/T3436-fix-a-bug'? [yn] y
-> Branch xclaesse/wip/phab/T3436-fix-a-bug was deleted
```
+
+HOW TO SET UP YOUR PROJECT
+==========================
+
+First of all, you need to add an `.arcconfig` to your project repository. This file
+is the same one as used by [arcanist] and you should follow their '[Configuring a New
+Project]' documentation to set write the configuration file.
+
+ [Configuring a New Project]: https://secure.phabricator.com/book/phabricator/article/arcanist_new_project/
+ [arcanist]: https://secure.phabricator.com/book/phabricator/article/arcanist/