Skip to content

Commit

Permalink
Update README, CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
crertel committed Jun 24, 2024
1 parent c9bb168 commit 95c75fb
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 8 deletions.
36 changes: 34 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,38 @@
## Unreleased
* Added Cairo support - @ringlej
## 0.12.0-rc.0
This is a major update that adds support for Cairo and makes Cairo the default renderer:

* Add Cairo support - @ringlej
* Restructure C code - @ringlej
* Add CI - @axelson
* Updat README for 0.12 - @axelson
* Improve text handling - @JediLuke
* Better control of scene element opacity wiht `:clear` background - @seb3s
* Add `input_blacklist` options to remove `InputEvent` streams - @ringlej
* Fix `script_opts_draw_line` to handle stroke properly - @ringlej
* Add arc script command - @GPrimola
* Fix `LINE_CAP_ROUND -> LINE_JOIN_ROUND` in nanovg backend - @ringlej
* Fix extra `free` in image code - @ringlej
* Fix hidden cursor on refocus and repaint for nanovg backend - @mneumann
* Fix readme typo - @seb3s
* Add FPS and debug logging - @ringlej
* Add alpha channel support for sprites - @seb3s
* Add support for rounded rectangles - @GPrimola
* Add configurable framebuffer device for cairo - @jimsynz
* Assorted updates for deprecations and warnings





Note: for Nerves setups you may need additional configuration for your display
to work as expected. If you're using an RPI3 you may want to add an `erlinit`
configuration so that your IEx output isn't displayed on the screen. To do so in your `config/target.exs` add:
```
# From: https://hexdocs.pm/nerves/1.10.5/connecting-to-a-nerves-target.html#hdmi-cable
`config :nerves, :erlinit, ctty: "ttyAMA0"`
```



## 0.11.0
Very minor fixes
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ This driver replaces both `:scenic_driver_glfw` and `:scenic_driver_nerves_rpi`

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `scenic_driver_local` to your list of dependencies in `mix.exs`:
scenic_driver_local can be installed by adding `scenic_driver_local` to your
list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:scenic_driver_local, "~> 0.11.0"}
{:scenic_driver_local, "~> 0.12.0"}
]
end
```
Expand All @@ -35,9 +35,9 @@ Example:

There are quite a few new options as well. It uses `NimbleOptions` to confirm them, so look at the `Scenic.Driver.Local` module for details.

## Targets
## Targets (Nerves)

This driver figures out what underlying graphics technology to use depending on what your MIX_TARGET is set to.
This driver figures out what underlying graphics technology to use depending on what your `MIX_TARGET` environment variable is set to.

For example, for apps running on a Mac/PC/Linux, it is usually set to `host`, which causes the driver to use `cairo-gtk` as the underlying tech.

Expand All @@ -49,7 +49,10 @@ Previous versions of `scenic_driver_local` would use `bcm` (Broadcom Manager) fo
You can explicitly use these by setting `SCENIC_LOCAL_TARGET=bcm` or `SCENIC_LOCAL_TARGET=drm`, **but these options are being deprecated**.
Please try the default of `SCENIC_LOCAL_TARGET=cairo-fb` as this should work universally on any Nerves target.

`cairo-fb` will require that your `nerves_system_*` has the `cairo` library selected.
`cairo-fb` will require that your `nerves_system_*` has the `cairo` library
selected via the `BR2_PACKAGE_CAIRO=y` buildroot configuration. If you're using
one of the official nerves systems then `BR2_PACKAGE_CAIRO=y` is configured by
default if you're using 1.25.0 or greater.

## Prerequisites

Expand Down Expand Up @@ -108,6 +111,9 @@ Lastly, install the GLEW package. Find the packaged `include` folder and extract

Once these components have been installed, you should be able to build the `scenic_driver_local` driver.

### Installing on Nerves

See the "Targets" section above

## Documentation

Expand Down

0 comments on commit 95c75fb

Please sign in to comment.