Awesome

• thesaurust
  • Installation
  • Installation (with spellchecking)
    • Prerequisites
    • Enabling spellchecking
  • Usage
  • Roadmap

thesaurust

A simple dictionary application built within the terminal, written in Rust.

How it works

The data is fetched from the API provided by https://dictionaryapi.dev/. Since words can contain more than one meanings, the user can toggle between different meanings based on the parts of speech the word has.

Installation

You need to install Rust before you can proceed. <br> Clone this repository:

git clone https://github.com/QuietPigeon2001/thesaurust

Navigate to the repository and run the following commands:

cargo install --path .
thesaurust

Installation (with spellchecking)

Prerequisites

You need to have an API key from SerpApi before you can enable this feature. It is free of charge with a limited number of usage. <br> Go to api_key.rs and enter your API key:

pub const API_KEY: &str = "YOUR_API_KEY";

Then, you can proceed to installation.

Enabling spellchecking

To enable spellchecking in the app, press <kbd>:</kbd> after launching the app. At the footer, you will see something like

Spelling suggestion: false

Toggle to Spelling suggestion to true with <kbd>l</kbd> or <kbd>h</kbd>, then press <kbd>q</kbd> to exit.

Usage

• <kbd>/</kbd>: Insert the word you would like to look up.
• <kbd>Enter</kbd>: Search.
• <kbd>j</kbd>, <kbd>k</kbd>: Select the part of speech and press <kbd>Enter</kbd>.
• <kbd>l</kbd>, <kbd>h</kbd>: Toggle between multiple definitions.
• <kbd>q</kbd>: Exit the app.

Roadmap

• Show an example with the definition (if available)
• Toggle between parts of speech
• Toggle between definitions with the same part of speech
• Use a spellchecking API to suggest correct spelling for words
• Show synonyms