From cdf244ae18202ad3d4fd006c6478a9409b77defe Mon Sep 17 00:00:00 2001 From: Alexander van Ratingen <470642+alvra@users.noreply.github.com> Date: Thu, 21 Apr 2022 22:27:03 +0200 Subject: [PATCH] Add readmes for all published crates. --- derive-macro/README.md | 3 +++ lib/README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 derive-macro/README.md create mode 100644 lib/README.md diff --git a/derive-macro/README.md b/derive-macro/README.md new file mode 100644 index 0000000..f1dfc2e --- /dev/null +++ b/derive-macro/README.md @@ -0,0 +1,3 @@ +# Generate-Random-Macro + +This crate provides the derive macro for the main crate (`generate-random`). diff --git a/lib/README.md b/lib/README.md new file mode 100644 index 0000000..c2458ae --- /dev/null +++ b/lib/README.md @@ -0,0 +1,29 @@ +# Generate-Random + +Generate random data. + +## Example + +```rust +use generate_random::GenerateRandom; + +#[derive(GenerateRandom)] +enum MyEnum { + A, + C(bool), + B { + x: u8, + }, + // Providing a weight allows changing the probabilities. + // This variant is now twice as likely to be generated as the others. + #[weight(2)] + D, +} + +let mut rng = rand::thread_rng(); +let my_value = MyEnum::generate_random(&mut rng); +``` + +## Documentation + +[Documentation](https://lib.rs/crates/generate-random) -- 2.44.0