Skip to content

Commit

Permalink
docs(README): add headings to examples
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcur committed Jun 29, 2024
1 parent f43df9d commit 739f43e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,16 @@ These examples are generated by [./scripts/examples.sh](scripts/examples.sh).
Note some of these examples send automated input to an interactive bash
session.

### Cowsay

```bash
$ termsnap -l 9 -c 28 -- cowsay Hello, world
```

![Termsnap output of the cowsay command saying "hello world"](./media/cow.svg)

### Neovim

```bash
$ termsnap -l 12 -c 60 -- nvim --clean ./scripts/example.py <<EOF
:set number
Expand All @@ -45,6 +49,8 @@ EOF

![Termsnap output of example Python code viewed in Neovim](./media/nvim.svg)

### ANSI colors

```bash
$ (
# `sleep` gives bash time to be ready for the command, if this is omitted
Expand All @@ -57,6 +63,8 @@ $ (

![Termsnap output of a dump of indexed terminal colors](./media/colors.svg)

### TTY information

```bash
$ (
sleep 0.05
Expand All @@ -69,6 +77,8 @@ $ (

![Termsnap output of some tty commands](./media/tty.svg)

### Tokei

```bash
$ termsnap -l 22 -c 80 -- tokei
```
Expand Down

0 comments on commit 739f43e

Please sign in to comment.