diff --git a/Cargo.lock b/Cargo.lock index 629bd4b..ce59da9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -115,7 +115,7 @@ dependencies = [ [[package]] name = "particlez" -version = "0.1.0" +version = "0.0.1" dependencies = [ "crossterm", "rand", diff --git a/Cargo.toml b/Cargo.toml index 75e26eb..2e85f6f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "particlez" -version = "0.1.0" +version = "0.0.1" edition = "2021" [dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..558a75e --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# particlez + +A toy particle system written in Rust with `crossterm`, maybe useful for TUI applications. + +## Examples + +#### Fall to Floor + +``` +cargo run --example fall_to_floor +``` + +![Fall to Floor](docs/fall_to_floor.gif) + +#### Rainfall + +``` +cargo run --example rainfall +``` + +![Rainfall](docs/rainfall.gif) + +#### Bugs Crawl + +``` +cargo run --example bugs_crawl +``` + +![Bugs Crawl](docs/bugs_crawl.gif) + +#### Spaceflight + +``` +cargo run --example spaceflight +``` + +![Spaceflight](docs/spaceflight.gif) + +## Changelog + +| Date | Version | Description | +| ---------- | ------- | ------------------------------------ | +| 2024-07-08 | 0.0.1 | Supports minimal animation examples. | diff --git a/docs/bugs_crawl.gif b/docs/bugs_crawl.gif new file mode 100644 index 0000000..d53fa8f Binary files /dev/null and b/docs/bugs_crawl.gif differ diff --git a/docs/fall_to_floor.gif b/docs/fall_to_floor.gif new file mode 100644 index 0000000..322ef63 Binary files /dev/null and b/docs/fall_to_floor.gif differ diff --git a/docs/rainfall.gif b/docs/rainfall.gif new file mode 100644 index 0000000..673fb69 Binary files /dev/null and b/docs/rainfall.gif differ diff --git a/docs/spaceflight.gif b/docs/spaceflight.gif new file mode 100644 index 0000000..40b3d79 Binary files /dev/null and b/docs/spaceflight.gif differ