Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #18

Merged
merged 1 commit into from
Aug 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ Make your own images like this! Look at at all the variety in the [examples](exa

![example image](https://github.com/jmbhughes/barnsley/blob/main/examples/example4.png?raw=true)

This code is based on [pyifs](https://github.com/jtauber/pyifs) written by [James Tauber](https://github.com/jtauber) for Python.
## Make your own!
You can use [https://barnsley.dev](https://barnsley.dev) to generate your own IFS and animations right in the browser.

This website is built in the [barnsley_gui repo](https://github.com/jmbhughes/barnsley_gui).

## How to run
## How to run crate
### Install
Rust is required to run this code. [Installation of Rust is easy though](https://www.rust-lang.org/tools/install).
Once you have rust, install Barnsley with `cargo install barnsley`.

Expand Down Expand Up @@ -40,11 +44,7 @@ It can be used to recreate an image at a later date.

Try different combinations of them to generate new images.

## Coming soon
- [x] the base package
- [x] a configurable main function
- [ ] more color schemes
- [ ] more transforms
- [ ] a mathematical guide
- [ ] classic fractals
- [ ] animation of the ifs executing
## Origins
This code is based on [pyifs](https://github.com/jtauber/pyifs) written by [James Tauber](https://github.com/jtauber) for Python.

The crate name is in honor of Michael Barnsley, a leading researcher of iterated function systems.