munemo-rs

Turn an integer into a Japan-ish word which is more easy to remember, or vice-versa. Example of numbers and their encoded value:

Number	Encoded Value
-1	xabi
2248	gume
2592	hayu
475349	munemo
94714682	yoshimitsu

munemo is my first crate and is one of the means for me to study Rust.

Getting Started

To use or develop this crate, you need Rust.

Usage

Add this crate under [dependency] section in your Cargo.toml file. Usage of this library is described on the documentation.

Hacking

This library is built using Test-Driven Development pattern. Here are rough pattern used while developing this library:

1. Write the test.
2. Ensure the test fails using cargo test.
3. Write the implementation.
4. Ensure the failing test has been suceeded using cargo test.
5. Make a Git commit.

Additional steps if you need to refactor:

1. Refactor the code.
2. Make sure the tests success using cargo test.
3. Make a Git commit.

To build this library, you can use cargo build. Additional cargo commands can be discovered in the documentation.

License

MIT.

References

Creation of this crate was inspired from munemo Ruby gem by John Mettraux.

In additional, here are resources I learnt while making this crate:

• The Rust Programming Language.
  • Defining Modules to Control Scope and Privacy.
  • Separating Modules into Different Files.
  • How to Write Tests.
  • Publishing a Crate to Crates.io.
• Rust API Guidelines Checklist.
• Crate rand.
• About Docs.rs.