Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #67

Merged
merged 2 commits into from
Nov 30, 2024
Merged

Update readme #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb24a15
Update readme
axelson Sep 25, 2023
42e0b52
update wording
axelson Nov 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
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
Loading