summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYingbo (Max) Wang <maxwyb@gmail.com>2018-09-30 14:30:12 -0700
committerBert Belder <bertbelder@gmail.com>2018-10-04 02:16:54 -0700
commit10232026342159ec2ad335dbec26b0d37af47303 (patch)
treed69be8c18c2af0cb8c405a0fd7ad5a66416c42fb
parentb9cdf088e7444b3fbad9ac02425425bb4f40355c (diff)
Update instructions on using ./tools/format.py in README
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6bb89a25f..572b0f481 100644
--- a/README.md
+++ b/README.md
@@ -125,6 +125,12 @@ submodule. However, you need to install separately:
# Format code.
./tools/format.py
+Before running `./tools/format.py`, make sure you have `yapf` installed for the
+current Python and `rustfmt` for Rust. They can be installed by:
+
+ pip install yapf
+ rustup component add rustfmt-preview
+
Other useful commands:
# Call ninja manually.