1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with
// this file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! Genere is a library to generate (possibly randomized) text with options to match the (grammatical) gender
//! of various elements.
//!
//! # Example
//!
//! ```
//! use genere::Generator;
//! let mut gen = Generator::new();
//! gen.add("hero", &["John[m]", "Joan[f]"]).unwrap();
//! gen.add("job[hero]", &["wizard/witch"]).unwrap();
//! gen.add("main[hero]", &["{hero}. He/She is a {job}."]).unwrap();
//! let result = gen.instantiate("main").unwrap();
//! assert!(&result == "John. He is a wizard."
//!        || &result == "Joan. She is a witch.");
//! ```
//!
//!
//! # More information
//!
//! Genere is inspired by [Tracery](http://tracery.io/), but seeks to allow easy generation
//! of sentences that are grammaticaly gender accurate.
//!
//! # TODO
//!
//! * Symbols must be declared in the order they will be used.
//! * Support for JSON.
//! * Support for "content·e" variants.
//!

mod errors;
mod generator;

pub use generator::Generator;
pub use generator::Gender;