Skip to content

Documentation: Fixing a typo and adding instructions in README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jooaf merged 1 commit into from
Dec 30, 2024
Merged

Documentation: Fixing a typo and adding instructions in README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The binary lives in `thoth/target/release/thoth`. You can add the binary to your
This will show how to use the scratchpad via the CLI or the TUI.

### TUI
To start the TUI, simple type `thoth`. Since it is a persistent buffer, thoth will save when you hit quit using `q`.
To start the TUI, simply type `thoth`. Since it is a persistent buffer, thoth will save when you hit quit using `q`.

#### Commands for main mode
```
Expand Down Expand Up @@ -161,7 +161,8 @@ for editing in `tui-textarea`.
| Ctrl+K | Format markdown block |
| Ctrl+J | Format JSON |

If you would like to use your external editor -- such as NeoVim, Helix, etc. -- Thoth offers that functionality.
If you would like to use your external editor -- such as NeoVim, Helix, etc. -- Thoth offers that functionality.
Please set your `$EDITOR` or `$VISUAL` environment variables to make use of this feature.

### CLI
For accessing the CLI, one can use `thoth` followed by a command.
Expand Down
Loading