summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Vanik <ben.vanik@gmail.com>2015-02-21 14:45:23 -0800
committerBen Vanik <ben.vanik@gmail.com>2015-02-21 14:45:23 -0800
commit4a211a4195ca5547ae779607613ac6e36b8f0bfd (patch)
tree21d972b79203d381179d3f29b0819195838f4a94 /docs
parent0f1e870d9901eb500137e2b0031821177fdec7c8 (diff)
'xb format' helper.
Diffstat (limited to 'docs')
-rw-r--r--docs/style_guide.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/style_guide.md b/docs/style_guide.md
index 4101f8946..e197da938 100644
--- a/docs/style_guide.md
+++ b/docs/style_guide.md
@@ -23,6 +23,14 @@ clang-format with the Google style is used to format all files. I recommend
installing/wiring it up to your editor of choice so that you don't even have to
think about tabs and wrapping and such.
+#### Command Line
+
+To use the `xb format` auto-formatter, you need to have a `clang-format` on your
+PATH. If you're on Windows you can do this by installing an LLVM binary package
+from [the LLVM downloads page](http://llvm.org/releases/download.html). If you
+install it to the default location the `xb format` command will find it
+automatically even if you don't choose to put all of LLVM onto your PATH.
+
#### Visual Studio
Grab the official [experimental Visual Studio plugin](http://llvm.org/builds/).