From 7e37cca0838a5dbe8929bc2cb29c82cbef293379 Mon Sep 17 00:00:00 2001 From: Cassie Jones Date: Sun, 7 Feb 2021 03:19:48 -0500 Subject: [PATCH] [Docs] Mention run.py and trace.py in the README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6156e77..0d66851 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,10 @@ directory of choice, or run the compiler in the Ivy project root directory via: ```shell $ env LIBRARY_PATH=rt/target/release cargo run --release ``` + +As a shortcut for running a program, you can use `tools/run.py` which will +compile and run a source file directly (handling the library path for you), +while simultaneously doing pretty-printing of debug output. + +To get pretty-printed debug output on a compiled binary, use `tools/trace.py` +to run it. -- 2.43.2