Skip to content

Commit

Permalink
added instructions about saving
Browse files Browse the repository at this point in the history
  • Loading branch information
zsunberg committed Apr 7, 2018
1 parent 07637e2 commit ec8faaf
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ car = ArrowCar([0.0, 0.0], 0.0, color=colorant"blue") # [north, east], angle
render([roadway, car, "some text"])
```

A short tutorial is located in [notebooks/tutorial.ipynb](notebooks/tutorial.ipynb).
In a jupyter notebook, an image will appear, otherwise see the [Saving images](#Saving-images) section below. A short tutorial is located in [notebooks/tutorial.ipynb](notebooks/tutorial.ipynb).

### Renderable
## Renderable

*What does it mean to be "renderable"?*

Expand Down Expand Up @@ -74,6 +74,10 @@ The following additional keyword arguments will accepted by `render()`:
- `overlays`
- `cam` - a camera controlling the field of view as in the previous version of AutoViz

## Saving images

Png images can be saved with `write_to_png(render(scene), "filename.png")`. Gif animations may be created with e.g. [Reel.jl](https://github.com/shashi/Reel.jl).

## `RenderModel`s

The mid-level interface for this package (which is what you will use when you write `render!()` for your types or when you write an overlay) revolves around adding instructions to a `RenderModel`. Each instruction consists of a function and a tuple of arguments for the function. This is not documented in this readme, but it is fairly easy to figure out by reading `rendermodels.jl`, `overlays.jl`, and `arrowcar.jl`.

0 comments on commit ec8faaf

Please sign in to comment.