Skip to content

Commit

Permalink
docs(v0.0.1): document particle system example usage
Browse files Browse the repository at this point in the history
  • Loading branch information
zpg6 committed Nov 29, 2024
1 parent dc82aaa commit 387bb87
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "particlez"
version = "0.1.0"
version = "0.0.1"
edition = "2021"

[dependencies]
Expand Down
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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. |
Binary file added docs/bugs_crawl.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fall_to_floor.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/rainfall.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/spaceflight.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 387bb87

Please sign in to comment.