diff options
author | George Burgess IV <gbiv@google.com> | 2019-03-05 16:56:49 -0800 |
---|---|---|
committer | chrome-bot <chrome-bot@chromium.org> | 2019-03-08 03:11:12 -0800 |
commit | 00050c97025ac8ea0999f5c3d1f26e3af7aac9ff (patch) | |
tree | 92fdab294ad808725c42fee4524bf709d45e8f0c /README.md | |
parent | d03481305c1de7f35da0d7b120585859e7b96da0 (diff) | |
download | toolchain-utils-00050c97025ac8ea0999f5c3d1f26e3af7aac9ff.tar.gz |
Swap READMEs to markdown
Suggested by vapier@ in I7daf1cbe93f8809e469698d7772a6c68baf9e194
This ignores README.chromium, since I'm unsure if that's a special name
that some tool somewhere relies on.
I skimmed over all of these in gitiles (as you can probably tell by the
35 patch sets :) ) and fixed the issues that jumped out at me. I'm sure
that some remain somewhere, but I think I got the majority of them.
An attempt has been made to make all files roughly follow the rules
here:
https://github.com/google/styleguide/blob/gh-pages/docguide/style.md
Note that not all of them have super meaningful introductions with
ToCs/etc, but the rest should be relatively consistent with that guide.
BUG=None
TEST=Manual inspection
Change-Id: I158048d972d49966e3b8ff1e07e5429928edb339
Reviewed-on: https://chromium-review.googlesource.com/1504893
Commit-Ready: George Burgess <gbiv@chromium.org>
Tested-by: George Burgess <gbiv@chromium.org>
Reviewed-by: George Burgess <gbiv@chromium.org>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..a318e38d --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# `toolchain-utils` + +Various utilities used by the Chrome OS toolchain team. + +## Note + +To run Python scripts in this directory, first run: + +``` +export PYTHONPATH=$(readlink -f .):$PYTHONPATH +``` + +from this directory. + +Then you can run any script. + +To get help on any script, type in `python <script> --help`, or refer to the +header of the script for more information. |