Skip to content

Commit

Permalink
updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jmbhughes committed Aug 5, 2023
1 parent 8854e6f commit e24e8e2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "barnsley"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
authors = ["Marcus Hughes <[email protected]>"]
license = "MIT OR Apache-2.0"
description = "iterated function system image generator"
documentation = "https://docs.rs/barnsley/latest/"
# documentation = "https://docs.rs/barnsley/latest/"
repository = "https://github.com/jmbhughes/barnsley"
keywords = ["image-generation", "iterated-function", "ifs", "mathematical-images"]
categories = ["mathematics", "multimedia::images", "rendering"]
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Make your own images like this! Look at at all the variety in the [examples](exa
This is based upon [pyifs](https://github.com/jtauber/pyifs) written by [James Tauber](https://github.com/jtauber) for Python.

## How to run
You can run from a template or a config.
First, install with `cargo install barnsley`.

Then, you can run from a template or a config.

### From a template
A template toml file specifies the image properties, the evaluation properties, and which transforms to run.
Expand All @@ -17,15 +19,15 @@ You can use the `construct` command in the program to generate a specific instan
to create an image.

1. Clone this repo
2. Using Rust, run `cargo run --release construct example_template.toml > test.json`
2. Using Rust, run `barnsley construct example_template.toml > test.json`
3. Look at your picture in the test.png file and the configuration in test.json

### From a config
A config json file specifies the image properties, the evaluation properties, and the specific parameters of transforms.
It can be used to recreate an image at a later date.

1. Clone this repo
2. Using Rust, run `cargo run --release construct examples/example7.json`
2. Using Rust, run `barnsley construct examples/example7.json`
3. Look at the example7.png file to see the result. Note how it matches the one in the examples directory!


Expand Down

0 comments on commit e24e8e2

Please sign in to comment.