Skip to content

Commit

Permalink
docs: include demos from assets, add lz demo GIF
Browse files Browse the repository at this point in the history
  • Loading branch information
rzmk authored Jan 2, 2024
1 parent 47ee3c8 commit 8bb474f
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ The `ladderz` project is a collection of math and tech concepts implemented in c
## Demos

### ladderz Library Demo

![ladderz-crate-demo](https://github.com/rzmk/ladderz/assets/30333942/ebebe82d-f2f7-4604-9ea8-641325c90997)
![ladderz-crate-demo-output](https://github.com/rzmk/ladderz/assets/30333942/e84b981a-91ca-40ed-af1b-d3115be848fd)

### `lz` CLI Demo

### ladderz Library Demo
![lz-demo](https://github.com/rzmk/ladderz/assets/30333942/e4f18934-b2bd-45cc-a948-ee28422f19e2)

## CLI Example

Expand Down Expand Up @@ -48,13 +53,13 @@ We can use the `--raw` flag to get the raw output of the function:
lz prealgebra get-factors 12 --raw
```

The printed output should be:
The printed output may be:

```console
{1, 2, 3, 4, 6, 12}
```

Note that the numbers may not be sorted.
Note that the numbers may not be sorted since the `get_factors` function implemented in the ladderz library returns a `HashSet<u32>`.

## Library Example

Expand Down

0 comments on commit 8bb474f

Please sign in to comment.