Skip to content

Commit 8324e58

Browse files
committed
Added NEWS.md
1 parent 9f25408 commit 8324e58

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

NEWS.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# VirtualPLantLab v0.0.2 release notes
2+
3+
There is no official release for VirtualPlantLab 0.0.1, so the changes below are relative to
4+
the (unregistered) VPL.jl.
5+
6+
## Changes to API
7+
8+
- All exported functions that are not associated to a data type use `snake_case` style,
9+
unless one of the words has a single letter. For example, `loadmesh` becomes `load_mesh` but
10+
`nvertices` remains the same in the API. Similarly, `isRoot` becomes `is_root`. Most of
11+
these changes affect the graph-related and rendering API. Functions associated to datatypes
12+
(i.e., constructors) use `CamelCase` but that was already the case (e.g., `SolidCube!` or
13+
`Scene`) so no changes there!.
14+
15+
- The function `feed!` now belongs to PlantGeomTurtle, so to define methods for `feed!` you
16+
should now use `PlantGeomTurtle.feed!` instead of `VPL.Geom.feed!`.
17+
18+
- The functions `render` and `draw` (and their mutating `!` versions) no longer have a `backend`
19+
argument to set the graphics backend. Instead, the user should import `GLMakie` (for native
20+
backend), `WGLMakie` (for web backend) or `CairoMakie` (for Cairo backend) before any call
21+
to `render` or `draw`. Note that these packages are not installed when installing
22+
VirtualPlantLab.jl, so the user may need to install them. Check the new version of the
23+
tutorials for more information.

0 commit comments

Comments
 (0)