Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 2.96 KB

README.md

File metadata and controls

73 lines (52 loc) · 2.96 KB
Raw

iching

Crates.io Documentation MIT/Apache Lines of Code

This library contains methods for divination using the I Ching. The related CLI app was inspired by the original ching(6) unix program.

The I Ching (a.k.a. the Book of Changes) is an ancient method of divination based on cleromancy (assigning meaning to the generation of apparently random numbers.) Six numbers between 6 and 9 are generated in order to create a hexagram, the meaning of which is contained in the I Ching book.

You can find lots of great information on the 2000+ year history of the I Ching on Wikipedia

Installing and running the CLI app

To install the CLI app, just run

cargo install iching

Once installed, you can access the help screen by running the CLI with no arguments.

If you find any issues, please submit them through Github.

A simplified example of using the library:

use iching::{Hexagram, HexagramOrdering, HexagramRepository};

// Implementing the HexagramRepository trait is the most complex
// aspect of using this library. See the included CLI app for an
// example implementation called HexagramExampleRepository.
let hexagrams: &mut dyn HexagramRepository<HexagramInfo = HexagramExampleInfo> = &mut HexagramExampleRepository::new();

// Don't forget to initialize repository after construction, else
// it could fail to work or even panic.
hexagrams.initialize().expect("Initialization of hexagrams has failed");

// Create a new random hexagram.
let new_hexagram = Hexagram::from_coin_tosses();
// Get the number of the hexagram according to changing lines and ordering
let hexagram_number = new_hexagram.as_number(false, HexagramOrdering::KingWen);

// Fetch the hexagram's info from the repository that was initialized earlier.
let hexagram_info = hexagrams.get_by_number(hexagram_number)
                           .expect("Failed to get hexagram info by number (pre)");

// Print the hexagram info for the user
print!("{hexagram_info:?}");

License

iching is free and open source software distributed under the terms of both the MIT License and the Apache License 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.