speller
| Crates.io | speller |
| lib.rs | speller |
| version | 0.1.0 |
| source | src |
| created_at | 2024-06-23 09:48:19.792088 |
| updated_at | 2024-06-23 09:48:19.792088 |
| description | CLI tool for phonetic spelling |
| homepage | |
| repository | https://github.com/francescofarina/speller |
| max_upload_size | |
| id | 1281098 |
| size | 29,134 |
Francesco Farina (francescofarina)
documentation
README
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:
- Clone the repository to your local machine:
git clone https://github.com/francescofarina/speller.git
- Change to the project directory:
cd speller
- Build the project:
cargo build
- 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.