Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
caycun authored Aug 3, 2024
1 parent 770bdb7 commit 6d33c30
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,22 @@ Create a dashboard where you can see all output from different terminal commands
## Demo
![](https://media.discordapp.net/attachments/1055343147833626757/1269101410205827143/Showcase.gif?ex=66aed64a&is=66ad84ca&hm=9c2075c67728ac9a43e2b7a97a280c925452b4ca05613a44c7fc2441ff8acc25&=)

## Keybinds

| Function | Key |
| ----------------- | ------------------------------------------------------------------ |
| Focus screen | `f + number`|
| Full screen mode | `Enter` |
| Exit full screen | `Esc`|
| Quit tdash | `q` |

## How to use
#### Step 1
```
cargo install tdash
```

#### Step 1
#### Step 2

Create a .yaml file with the commands you want to use

Expand All @@ -30,18 +42,11 @@ direction: 2

Currently, direction system is not implemented yet. Direction is whether the screen should be horizontal[1] or vertical[2]

#### Step 2
#### Step 3

Run the command:
`cargo run -- --file <yaml_file_name>`
`tdash -file <yaml_file_name>`

## Keybinds

| Function | Key |
| ----------------- | ------------------------------------------------------------------ |
| Focus screen | `f + number`|
| Full screen mode | `Enter` |
| Exit full screen | `Esc`|
| Quit tdash | `q` |


0 comments on commit 6d33c30

Please sign in to comment.