Merge pull request #128 from wcampbell0x2a/add-vhs-docs

Author: wcampbell0x2a

README.md

@@ -3,11 +3,14 @@
 [<img alt="crates.io" src="https://img.shields.io/crates/v/heretek.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/heretek)
 [<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/wcampbell0x2a/heretek/main.yml?branch=master&style=for-the-badge" height="20">](https://github.com/wcampbell0x2a/heretek/actions?query=branch%3Amaster)
 
-GDB TUI Dashboard. Connect remotely with gdb when you don't have a working `gdbserver`, and show tui inspired by `gef`.
+GDB TUI Dashboard inspired by `gef`, designed to seamlessly connect to remote targets even without a functioning `gdbserver`.
 
-* **No gdbserver requirements**: Many vendors ship invalid `gdbserver` binaries, this works on remote targets with just `gdb`, `nc`, `cat`, and `mkfifo`.
-* **No python requirements**: Many vendors ship `gdb` without python support.
+* **No python requirements**: Many vendors ship `gdb` without python support, we ship a single statically-linked musl binary.
 * **Architecture agnostic**: `heretek` only uses information given by `gdb`, no extra code required!
+* **No gdbserver requirements**: Many vendors ship invalid `gdbserver` binaries, this works on remote targets with just `gdb`, `nc`, `cat`, and `mkfifo`. No more wrestling with invalid or missing `gdbserver` binaries.
+
+* See [features](./docs/features.md) for `heretek` demos.
+* See [commands](./docs/commands.md) for internal `heretek` commands.
 
 ![screenshot](images/screenshot.png)
 
@@ -54,7 +57,4 @@ Options:
           Print version
 ```
 
-## Info
-See [commands](./docs/commands.md) for internal `heretek` commands.
-
 > "To every problem, a solution lies in the application of tech-lore" - Ferrarch Asklepian, Warhammer 40,000: Mechanicus

RELEASE.md

@@ -1,6 +1,12 @@
 # Update screenshot
-```
-$ cargo r --profile=dist -- --cmds "test-sources/test.source"
+```sh
+$ cargo r --profile=dist -- --cmds test-sources/test.source
 $ wmctrl -lx
 $ import -window {id} images/screenshot.png
 ```
+
+# Update vhs
+```sh
+$ vhs docs/vhs/main.tape
+$ vhs docs/vhs/hexdump.tape
+```

docs/features.md

@@ -0,0 +1,13 @@
+# Main
+The main display shows the Registers, Stack, Instructions, and Output that is current to the the gdb session.
+Those sections can be expanded by selecting the function keys shown at the top.
+
+The following example shows an operator stepping through a function using `si`.
+![main](./main_section.gif)
+
+# Hexdump
+The hexdump screen is an easy way to see the color coded contents of the Heap, Stack, or another mapping or offset.
+Each register is shown if the value matches the address being dumped.
+
+The following example shows an operator dumping the contents of the Heap and searching.
+![hexdump](./hexdump_section.gif)

docs/hexdump_section.gif

@@ -0,0 +1,35 @@
+Output docs/hexdump_section.gif
+Set Theme ayu
+Set Padding 2
+Set FontSize 10
+Set Width 1000
+Set Height 800
+
+Hide
+Type "cargo r --release -- --cmds test-sources/test.source"
+Enter
+
+# Pause for dramatic effect...
+Tab
+Tab
+Tab
+Tab
+Tab
+Tab
+Show
+Type "H"
+Sleep 1s
+Type "J"
+Sleep 2s
+Type "J"
+Sleep 1s
+Type "J"
+Sleep 1s
+Type "J"
+Sleep 1s
+Type "J"
+Sleep 1s
+Type "J"
+Sleep 1s
+Type "J"
+Sleep 1s

docs/main_section.gif

@@ -0,0 +1,41 @@
+Output docs/main_section.gif
+Set Theme ayu
+Set Padding 2
+Set FontSize 10
+Set Width 1000
+Set Height 800
+
+Hide
+Type "cargo r --release -- --cmds test-sources/test.source"
+Enter
+Sleep 5s
+
+Show
+Type "i"
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s
+
+Type "si"
+Enter
+Sleep 2s