DotHyphen

A basic ASCII to Morse translator.

Requirements

Mandatory

• Rust

Optional

• Make
• Visual Studio Code

Contributing

• It is recommended to use Visual Studio Code, using the samuel.code-workspace workspace and install all recommended extensions.
• Use Conventional Commits.
• Use Feature Branch creating a pull request to main.
• Add unit testing whenever possible.

Unit testing

To execute the unit tests, run:

dothyphen~ cargo test

Building

As many others Rust crates you must use cargo to build DotHyphen library.

dothyphen~ cargo build --target x86_64-unknown-linux-gnu --release

Change the target if you want to build the crate to other platforms like Windows or macOS. Remove --release if you want a debug version. Remember, the build output will be placed in the root of the workspace. For example, target/x86_64-unknown-linux-gnu/release/libdothyphen.rlib

Usage

Add dothyphen as a dependency, then:

use dothyphen::translate;

let translated_string = translate("Hello World");
println!("{}", translated_string); // Should print .... . .-.. .-.. --- / .-- --- .-. .-.. -..

Publish

This crate follows the official documentation to be published into crates.io.