Skip to content

Commit

Permalink
Update readme (#67)
Browse files Browse the repository at this point in the history
* Update readme

- Make it more clear that the two scenic.new commands are used separately
- Make the version of Elixir and Erlang/OTP required more obvious (fixes #37)
- Add a link to `scenic_driver_local`

* update wording
  • Loading branch information
axelson authored Nov 30, 2024
1 parent 28cb970 commit 984224b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,26 @@ Then you can create the example applications.

```
mix scenic.new simple
# Alternatively if you want a fully featured example application you can run:
mix scenic.new.example demo
```


## Erlang/Elixir versions

Please note, it currently needs OTP 21 and Elixir 1.7. If you have trouble
compiling, please check that you are running those versions first.
Please note, Scenic currently needs OTP 23 and Elixir 1.11 or greater. If you
have trouble compiling, please check that you are running those versions or
greater first.

## Install Prerequisites

The design of Scenic goes to great lengths to minimize its dependencies to just
the minimum. Namely, it needs Erlang/Elixir and OpenGL.

Rendering your application into a window on your local computer (MacOS, Ubuntu
and others) is done by the `scenic_driver_local` driver. It uses the GLFW and
GLEW libraries to connect to OpenGL.
and others) is done by the
[`scenic_driver_local`](https://github.com/ScenicFramework/scenic_driver_local/)
driver. It uses the GLFW and GLEW libraries to connect to OpenGL.

The instructions below assume you have already installed Elixir/Erlang. If you
need to install Elixir/Erlang there are instructions on the [elixir-lang
Expand Down

0 comments on commit 984224b

Please sign in to comment.