1 unstable release

0.1.0 Jun 23, 2024

#1002 in Command line utilities

MIT/Apache

11KB
133 lines

Speller

Speller is a Rust-based command-line application that helps users spell words using the phonetic alphabet of different languages.

Features

  • Spell words using the phonetic alphabet.
  • Support for multiple languages through a configurable TOML file.
  • Easy to use command-line interface.

Installation

Pre-built binaries

You can install and use Speller through cargo by running the following command:

cargo install speller

Development

To install Speller, you need to have Rust and Cargo installed on your machine. Follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/francescofarina/speller.git
  1. Change to the project directory:
cd speller
  1. Build the project:
cargo build
  1. Run the project:
cargo run

Usage

Upon starting the application, you will be prompted to enter a word to spell. Type the word and press Enter. The application will then display the phonetic spelling of the word in the configured language. You can change the language or exit the application by using the special commands \l and \q, respectively.

License

This project is licensed under either of MIT license or Apache License, Version 2.0, at your option.

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues.

Dependencies

~1–11MB
~75K SLoC