<commit_before># kaze

An [HDL](https://en.wikipedia.org/wiki/Hardware_description_language) embedded in [Rust](https://www.rust-lang.org/).

kaze provides an API to describe `Module`s composed of `Signal`s, which can then be used to generate Rust simulator code or verilog modules.

kaze's API is designed to be as minimal as possible while still being expressive.
It's designed to keep the user from being able to describe buggy or incorrect hardware as much as possible.
This enables a user to hack on designs fearlessly, while the API and generators ensure that these designs are sound.

## Usage

```toml
[dependencies]
kaze = "0.1"
```

## Example

```rust
use kaze::*;<commit_msg>Add badges<commit_after># kaze

An [HDL](https://en.wikipedia.org/wiki/Hardware_description_language) embedded in [Rust](https://www.rust-lang.org/).

[![Latest version](https://img.shields.io/crates/v/kaze.svg)](https://crates.io/crates/kaze)
[![Documentation](https://docs.rs/kaze/badge.svg)](https://docs.rs/kaze)
![License](https://img.shields.io/crates/l/kaze.svg)

kaze provides an API to describe `Module`s composed of `Signal`s, which can then be used to generate Rust simulator code or verilog modules.

kaze's API is designed to be as minimal as possible while still being expressive.
It's designed to keep the user from being able to describe buggy or incorrect hardware as much as possible.
This enables a user to hack on designs fearlessly, while the API and generators ensure that these designs are sound.

## Usage

```toml
[dependencies]
kaze = "0.1"
```

## Example

```rust
use kaze::*;
{'fraction_non_alphanumeric': 0.11502199874292897, 'fraction_numerical': 0.00251414204902577, 'mean_word_length': 4.726618705035971, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1577326', 'n_tokens_mistral': 505, 'n_tokens_neox': 476, 'n_words': 188}