diff --git a/triton-tui/README.md b/triton-tui/README.md index 9b32b7e17..637399431 100644 --- a/triton-tui/README.md +++ b/triton-tui/README.md @@ -1,3 +1,29 @@ # Triton TUI A TUI to run and debug programs written for Triton VM. + +Example run of Triton TUI + +## Getting Started + +Triton TUI tries to be helpful 🙂. List possible (and required) arguments with `triton-tui --help`. In the TUI, press `h` to access the help screen. + +The [example program](./examples/program.tasm), serving as the tutorial, can be run with + +```sh +triton-tui --program examples/program.tasm +``` + +## Installation + +Through [crates.io](https://crates.io/crates/triton-tui): + +```sh +cargo install triton-tui +``` + +Locally: + +```sh +cargo install --path . +``` diff --git a/triton-tui/examples/triton-tui.gif b/triton-tui/examples/triton-tui.gif new file mode 100644 index 000000000..835ea897a Binary files /dev/null and b/triton-tui/examples/triton-tui.gif differ diff --git a/triton-tui/examples/triton-tui.tape b/triton-tui/examples/triton-tui.tape new file mode 100644 index 000000000..44bd90e77 --- /dev/null +++ b/triton-tui/examples/triton-tui.tape @@ -0,0 +1,36 @@ +Output triton-tui.gif + +Set Shell zsh +Set Width 2000 +Set Height 1000 + +Sleep 1s +Hide +Type "triton-tui -p ./program.tasm -i public_input.txt -n non_determinism.json" +Show +Sleep 1s +Enter +Sleep 3s + +Type "c" +Sleep 2s +Type "c" +Sleep 2s +Type "c" +Sleep 2s +Type "ti" +Type "tc" +Sleep 2s +Type "ff" +Sleep 3s + +Type "m" +Sleep 3s +Enter +Type "30" +Enter +Sleep 3s + +Hide +Type "q" +Ctrl+D