Skip to content

Commit

Permalink
update README to help get started
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-ferdinand committed Dec 21, 2023
1 parent 1ae24f3 commit 2629d06
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
26 changes: 26 additions & 0 deletions triton-tui/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Triton TUI

A TUI to run and debug programs written for Triton VM.

<img alt="Example run of Triton TUI" src="./examples/triton-tui.gif" width="800" />

## 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 .
```
Binary file added triton-tui/examples/triton-tui.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions triton-tui/examples/triton-tui.tape
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2629d06

Please sign in to comment.