Skip to content

Commit

Permalink
Merge pull request #17 from PeggyYuchunWang/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
MaximeBouton committed Jan 14, 2019
2 parents 6b59bab + 320dc35 commit 13d2f58
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,6 @@ Png images can be saved with `write_to_png(render(scene), "filename.png")`. Gif
## `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`.

## Installation
`julia> Pkg.add(PackageSpec(url="https://github.com/sisl/AutoViz.jl.git"))`

0 comments on commit 13d2f58

Please sign in to comment.